//============================================================================= // Copyright (c) 2001-2021 FLIR Systems, Inc. All Rights Reserved. // // This software is the confidential and proprietary information of FLIR // Integrated Imaging Solutions, Inc. ("Confidential Information"). You // shall not disclose such Confidential Information and shall use it only in // accordance with the terms of the license agreement you entered into // with FLIR Integrated Imaging Solutions, Inc. (FLIR). // // FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE // SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE // IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES // SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING // THIS SOFTWARE OR ITS DERIVATIVES. //============================================================================= #ifndef FLIR_SPINNAKER_DEFS_C_H #define FLIR_SPINNAKER_DEFS_C_H #include "SpinnakerPlatformC.h" #include /** * @defgroup SpinnakerDefsC Spinnaker C Definitions * @ingroup SpinnakerC * * Definitions for Spinnaker C API * * Holds enumerations, typedefs and structures that are used across the * Spinnaker C API wrapper. */ /*@{*/ typedef uint8_t bool8_t; static const bool8_t False = 0; static const bool8_t True = 1; /** * @defgroup SpinnakerHandlesC Spinnaker C Handles * * Spinnaker C handle definitions */ /*@{*/ /** * Handle for system functionality. Created by calling * spinSystemGetInstance(), which requires a call to * spinSystemReleaseInstance() to release. */ typedef void* spinSystem; /** * Handle for interface list functionality. Created by calling * spinSystemGetInterfaces(), which requires a call to * spinInterfaceListClear() to clear, or spinInterfaceListCreateEmpty(), * which requires a call to spinInterfaceListDestroy() to destroy. */ typedef void* spinInterfaceList; /** * Handle for interface functionality. Created by calling * spinInterfaceListGet(), which requires a call to * spinInterfaceRelease() to release. */ typedef void* spinInterface; /** * Handle for interface functionality. Created by calling * spinSystemGetCameras() or spinInterfaceGetCameras(), which require * a call to spinCameraListClear() to clear, or * spinCameraListCreateEmpty(), which requires a call to * spinCameraListDestroy() to destroy. */ typedef void* spinCameraList; /** * Handle for camera functionality. Created by calling * spinCameraListGet(), which requires a call to spinCameraRelease() to * release. */ typedef void* spinCamera; /** * Handle for image functionality. Created by calling * spinCameraGetNextImage() or spinCameraGetNextImageEx(), which require * a call to spinImageRelease() to remove from buffer, or * spinImageCreateEmpty(), spinImageCreateEx(), or spinImageCreate(), * which require a call to spinImageDestroy() to destroy. */ typedef void* spinImage; /** * Handle for image statistics functionality. Created by calling * spinImageStatisticsCreate(), which requires a call to * spinImageStatisticsDestroy() to destroy. */ typedef void* spinImageStatistics; /** * Handle for device event handler functionality. Created by calling * spinDeviceEventHandlerCreate(), which requires a call to spinDeviceEventHandlerDestroy() * to destroy. */ typedef void* spinDeviceEventHandler; /** * Handle for image event handler functionality. Created by calling * spinImageEventHandlerCreate(), which requires a call to spinImageEventHandlerDestroy() * to destroy. */ typedef void* spinImageEventHandler; /** * Handle for arrival event handler functionality. Created by calling * spinArrivalEventCreate(), which requires a call to * spinDeviceArrivalEventHandlerDestroy() to destroy. */ typedef void* spinDeviceArrivalEventHandler; /** * Handle for removal event handler functionality. Created by calling * spinDeviceRemovalEventHandlerCreate(), which requires a call to * spinDeviceRemovalEventHandlerDestroy() to destroy. */ typedef void* spinDeviceRemovalEventHandler; /** * Handle for interface event handler functionality. Created by calling * spinInterfaceEventHandlerCreate(), which requires a call to * spinInterfaceEventHandlerDestroy() to destroy. */ typedef void* spinInterfaceEventHandler; /** * Handle for logging event handler functionality. Created by calling * spinLogEventHandlerCreate(), which requires a call to spinLogEventHandlerDestroy() * to destroy. */ typedef void* spinLogEventHandler; /** * Handle for logging event data functionality. Received in log event * function. No need to release, clear, or destroy. */ typedef void* spinLogEventData; /** * Handle for device event data functionality. Received in device event * function. No need to release, clear, or destroy. */ typedef void* spinDeviceEventData; /** * Handle for video recording functionality. Created by calling * spinVideoOpenUncompressed(), spinVideoOpenMJPG(), and * spinVideoOpenH264(), which require a call to * spinVideoClose() to destroy. */ typedef void* spinVideo; /*@}*/ /** * @defgroup SpinnakerFuncSignatureC Spinnaker C Function Signatures * * Spinnaker C function signature definitions */ /*@{*/ /** * Function signatures are used to create and trigger callbacks and * events. */ typedef void (*spinDeviceEventFunction)(const spinDeviceEventData hEventData, const char* pEventName, void* pUserData); typedef void (*spinImageEventFunction)(const spinImage hImage, void* pUserData); typedef void (*spinArrivalEventFunction)(uint64_t deviceSerialNumber, void* pUserData); typedef void (*spinRemovalEventFunction)(uint64_t deviceSerialNumber, void* pUserData); typedef void (*spinLogEventFunction)(const spinLogEventData hEventData, void* pUserData); /*@}*/ /** * @defgroup SpinnakerEnumsC Spinnaker C Enumerations * * Spinnaker C enumumeration definitions */ /*@{*/ /** * The error codes used in Spinnaker C. These codes are returned from every * function in Spinnaker C. */ /** The error codes in the range of -2000 to -2999 are reserved * for GenICam related errors. The error codes in the range of -3000 to -3999 * are reserved for image processing related errors. */ typedef enum _spinError { /** * An error code of 0 means that the function has run without error. */ SPINNAKER_ERR_SUCCESS = 0, /** * The error codes in the range of -1000 to -1999 are reserved for * Spinnaker exceptions. */ SPINNAKER_ERR_ERROR = -1001, SPINNAKER_ERR_NOT_INITIALIZED = -1002, SPINNAKER_ERR_NOT_IMPLEMENTED = -1003, SPINNAKER_ERR_RESOURCE_IN_USE = -1004, SPINNAKER_ERR_ACCESS_DENIED = -1005, SPINNAKER_ERR_INVALID_HANDLE = -1006, SPINNAKER_ERR_INVALID_ID = -1007, SPINNAKER_ERR_NO_DATA = -1008, SPINNAKER_ERR_INVALID_PARAMETER = -1009, SPINNAKER_ERR_IO = -1010, SPINNAKER_ERR_TIMEOUT = -1011, SPINNAKER_ERR_ABORT = -1012, SPINNAKER_ERR_INVALID_BUFFER = -1013, SPINNAKER_ERR_NOT_AVAILABLE = -1014, SPINNAKER_ERR_INVALID_ADDRESS = -1015, SPINNAKER_ERR_BUFFER_TOO_SMALL = -1016, SPINNAKER_ERR_INVALID_INDEX = -1017, SPINNAKER_ERR_PARSING_CHUNK_DATA = -1018, SPINNAKER_ERR_INVALID_VALUE = -1019, SPINNAKER_ERR_RESOURCE_EXHAUSTED = -1020, SPINNAKER_ERR_OUT_OF_MEMORY = -1021, SPINNAKER_ERR_BUSY = -1022, /** * The error codes in the range of -2000 to -2999 are reserved for * Gen API related errors. */ GENICAM_ERR_INVALID_ARGUMENT = -2001, GENICAM_ERR_OUT_OF_RANGE = -2002, GENICAM_ERR_PROPERTY = -2003, GENICAM_ERR_RUN_TIME = -2004, GENICAM_ERR_LOGICAL = -2005, GENICAM_ERR_ACCESS = -2006, GENICAM_ERR_TIMEOUT = -2007, GENICAM_ERR_DYNAMIC_CAST = -2008, GENICAM_ERR_GENERIC = -2009, GENICAM_ERR_BAD_ALLOCATION = -2010, /** * The error codes in the range of -3000 to -3999 are reserved for * image processing related errors. */ SPINNAKER_ERR_IM_CONVERT = -3001, SPINNAKER_ERR_IM_COPY = -3002, SPINNAKER_ERR_IM_MALLOC = -3003, SPINNAKER_ERR_IM_NOT_SUPPORTED = -3004, SPINNAKER_ERR_IM_HISTOGRAM_RANGE = -3005, SPINNAKER_ERR_IM_HISTOGRAM_MEAN = -3006, SPINNAKER_ERR_IM_MIN_MAX = -3007, SPINNAKER_ERR_IM_COLOR_CONVERSION = -3008, /** * Error codes less than -10000 are reserved for user-defined custom * errors. */ SPINNAKER_ERR_CUSTOM_ID = -10000 } spinError; /** * Color processing algorithms. Please refer to our knowledge base at * article at * https://www.flir.com/support-center/iis/machine-vision/knowledge-base/different-color-processing-algorithms-in-flycapture2 * for complete details for each algorithm. */ typedef enum _spinColorProcessingAlgorithm { /** Default method. */ DEFAULT, /** No color processing. */ NO_COLOR_PROCESSING, /** * Fastest but lowest quality. Equivalent to * FLYCAPTURE_NEAREST_NEIGHBOR_FAST in FlyCapture. */ NEAREST_NEIGHBOR, /** * Nearest Neighbor with averaged green pixels. Higher quality but slower * compared to nearest neighbor without averaging. */ NEAREST_NEIGHBOR_AVG, /** Weighted average of surrounding 4 pixels in a 2x2 neighborhood. */ BILINEAR, /** Weights surrounding pixels based on localized edge orientation. */ EDGE_SENSING, /** Well-balanced speed and quality. */ HQ_LINEAR, /** Multi-threaded with similar results to edge sensing. */ IPP, /** Best quality but much faster than rigorous. */ DIRECTIONAL_FILTER, /** Slowest but produces good results. */ RIGOROUS, /** Weighted pixel average from different directions. */ WEIGHTED_DIRECTIONAL_FILTER } spinColorProcessingAlgorithm; /** * Channels that allow statistics to be calculated. */ typedef enum _spinStatisticsChannel { GREY, RED, GREEN, BLUE, HUE, SATURATION, LIGHTNESS, NUM_STATISTICS_CHANNELS } spinStatisticsChannel; /** File formats to be used for saving images to disk. */ typedef enum _spinImageFileFormat { FROM_FILE_EXT = -1, /**< Determine file format from file extension. */ PGM, /**< Portable gray map. */ PPM, /**< Portable pixmap. */ BMP, /**< Bitmap. */ JPEG, /**< JPEG. */ JPEG2000, /**< JPEG 2000. */ TIFF, /**< Tagged image file format. */ PNG, /**< Portable network graphics. */ RAW, /**< Raw data. */ IMAGE_FILE_FORMAT_FORCE_32BITS = 0x7FFFFFFF } spinImageFileFormat; /** * This enum represents the namespace in which the TL specific pixel format * resides. This enum is returned from a captured image when calling * spinImageGetTLPixelFormatNamespace(). It can be used to interpret the raw * pixel format returned from spinImageGetTLPixelFormat(). * * @see spinImageGetTLPixelFormat() * * @see spinImageGetTLPixelFormatNamespace() */ typedef enum _spinPixelFormatNamespaceID { SPINNAKER_PIXELFORMAT_NAMESPACE_UNKNOWN = 0, /* GenTL v1.2 */ SPINNAKER_PIXELFORMAT_NAMESPACE_GEV = 1, /* GenTL v1.2 */ SPINNAKER_PIXELFORMAT_NAMESPACE_IIDC = 2, /* GenTL v1.2 */ SPINNAKER_PIXELFORMAT_NAMESPACE_PFNC_16BIT = 3, /* GenTL v1.4 */ SPINNAKER_PIXELFORMAT_NAMESPACE_PFNC_32BIT = 4, /* GenTL v1.4 */ SPINNAKER_PIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000 } spinPixelFormatNamespaceID; /** Status of images returned from spinImageGetStatus() call. */ typedef enum _spinImageStatus { IMAGE_UNKNOWN_ERROR = -1, /**< Image has an unknown error. */ IMAGE_NO_ERROR = 0, /**< Image is returned from GetNextImage() call without any errors. */ IMAGE_CRC_CHECK_FAILED = 1, /**< Image failed CRC check. */ IMAGE_DATA_OVERFLOW = 2, /**< Received more data than the size of the image. */ IMAGE_MISSING_PACKETS = 3, /**< Image has missing packets. Potential fixes include enabling jumbo packets and adjusting packet size/delay. For more information see https://www.flir.com/support-center/iis/machine-vision/application-note/troubleshooting-image-consistency-errors/ */ IMAGE_LEADER_BUFFER_SIZE_INCONSISTENT = 4, /**< Image leader is incomplete. Could be caused by missing packet(s). See link above.*/ IMAGE_TRAILER_BUFFER_SIZE_INCONSISTENT = 5, /**< Image trailer is incomplete. Could be caused by missing packet(s). See link above.*/ IMAGE_PACKETID_INCONSISTENT = 6, /**< Image has an inconsistent packet id. Could be caused by missing packet(s). See link above.*/ IMAGE_MISSING_LEADER = 7, /**< Image leader is missing. Could be caused by missing packet(s). See link above.*/ IMAGE_MISSING_TRAILER = 8, /**< Image trailer is missing. Could be caused by missing packet(s). See link above.*/ IMAGE_DATA_INCOMPLETE = 9, /**< Image data is incomplete. Could be caused by missing packet(s). See link above.*/ IMAGE_INFO_INCONSISTENT = 10, /**< Image info is corrupted. Could be caused by missing packet(s). See link above.*/ IMAGE_CHUNK_DATA_INVALID = 11, /**< Image chunk data is invalid */ IMAGE_NO_SYSTEM_RESOURCES = 12 /**< Image cannot be processed due to lack of system resources. */ } spinImageStatus; /** log levels */ typedef enum _spinLogLevel { LOG_LEVEL_OFF = -1, // Logging is off. LOG_LEVEL_FATAL = 0, // Not used by Spinnaker. LOG_LEVEL_ALERT = 100, // Not used by Spinnaker. LOG_LEVEL_CRIT = 200, // Not used by Spinnaker. LOG_LEVEL_ERROR = 300, // Failures that are non-recoverable without user intervention. LOG_LEVEL_WARN = 400, // Failures that are recoverable without user intervention. LOG_LEVEL_NOTICE = 500, // Events such as camera arrival and removal, initialization and deinitialization, starting // and stopping image acquisition, and feature modification. LOG_LEVEL_INFO = 600, // Information about recurring events that are generated regularly such as information on // individual images. LOG_LEVEL_DEBUG = 700, // Information that can be used to troubleshoot the system. LOG_LEVEL_NOTSET = 800 // Logs everything. } spinnakerLogLevel; /* Enumeration of TLType dependent payload types. Introduced in GenTL v1.2 */ typedef enum _spinPayloadTypeInfoIDs { PAYLOAD_TYPE_UNKNOWN = 0, /* GenTL v1.2 */ PAYLOAD_TYPE_IMAGE = 1, /* GenTL v1.2 */ PAYLOAD_TYPE_RAW_DATA = 2, /* GenTL v1.2 */ PAYLOAD_TYPE_FILE = 3, /* GenTL v1.2 */ PAYLOAD_TYPE_CHUNK_DATA = 4, /* GenTL v1.2, Deprecated in GenTL 1.5*/ PAYLOAD_TYPE_JPEG = 5, /* GenTL v1.4 */ PAYLOAD_TYPE_JPEG2000 = 6, /* GenTL v1.4 */ PAYLOAD_TYPE_H264 = 7, /* GenTL v1.4 */ PAYLOAD_TYPE_CHUNK_ONLY = 8, /* GenTL v1.4 */ PAYLOAD_TYPE_DEVICE_SPECIFIC = 9, /* GenTL v1.4 */ PAYLOAD_TYPE_MULTI_PART = 10, /* GenTL v1.5 */ PAYLOAD_TYPE_CUSTOM_ID = 1000, /* Starting value for GenTL Producer custom IDs. */ PAYLOAD_TYPE_EXTENDED_CHUNK = 1001, PAYLOAD_TYPE_LOSSLESS_COMPRESSED = 1002, PAYLOAD_TYPE_LOSSY_COMPRESSED = 1003, PAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED = 1004, PAYLOAD_TYPE_CHUNK_DATA_LOSSLESS_COMPRESSED = 1005, PAYLOAD_TYPE_CHUNK_DATA_LOSSY_COMPRESSED = 1006 } spinPayloadTypeInfoIDs; /*@}*/ /** * @defgroup SpinnakerStructC Spinnaker C Structures * * Spinnaker C structure definitions */ /*@{*/ /** * Options for saving PNG images. Used in saving PNG images * with a call to spinImageSavePng(). */ typedef struct _spinPNGOption { /** Whether to save the PNG as interlaced. */ bool8_t interlaced; /** Compression level (0-9). 0 is no compression, 9 is best compression. */ unsigned int compressionLevel; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinPNGOption() { interlaced = FALSE; compressionLevel = 6; memset(reserved, 0, sizeof(reserved)); }*/ } spinPNGOption; /** * Options for saving PPM images. Used in saving PPM images * with a call to spinImageSavePpm(). */ typedef struct _spinPPMOption { /** Whether to save the PPM as a binary file. */ bool8_t binaryFile; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinPPMOption() { binaryFile = true; memset(reserved, 0, sizeof(reserved)); }*/ } spinPPMOption; /** Options for saving PGM images. */ typedef struct _spinPGMOption { /** Whether to save the PPM as a binary file. */ bool8_t binaryFile; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinPGMOption() { binaryFile = true; memset(reserved, 0, sizeof(reserved)); }*/ } spinPGMOption; /** Compression method used in saving TIFF images in the spinTIFFOption struct. */ typedef enum CompressionMethod { NONE = 1, // Save without any compression. PACKBITS, // Save using PACKBITS compression. DEFLATE, // Save using DEFLATE compression (ZLIB compression). ADOBE_DEFLATE, // Save using ADOBE DEFLATE compression // Save using CCITT Group 3 fax encoding. This is only valid for // 1-bit images only. Default to LZW for other bit depths. // CCITTFAX3, // Save using CCITT Group 4 fax encoding. This is only valid for // 1-bit images only. Default to LZW for other bit depths. CCITTFAX4, LZW, //< Save using LZW compression. // // Save using JPEG compression. This is only valid for 8-bit // greyscale and 24-bit only. Default to LZW for other bit depths. // JPG } spinCompressionMethod; /** * Options for saving TIFF images. Used in saving PPM images * with a call to spinImageSaveTiff(). */ typedef struct _spinTIFFOption { /** Compression method to use for encoding TIFF images. */ spinCompressionMethod compression; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinTIFFOption() { compression = LZW; memset(reserved, 0, sizeof(reserved)); }; */ } spinTIFFOption; /** * Options for saving JPEG images. Used in saving PPM images * with a call to spinImageSaveJpeg(). */ typedef struct _spinJPEGOption { /** Whether to save as a progressive JPEG file. */ bool8_t progressive; /** * JPEG image quality in range (0-100). * - 100 - Superb quality. * - 75 - Good quality. * - 50 - Normal quality. * - 10 - Poor quality. */ unsigned int quality; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinJPEGOption() { progressive = false; quality = 75; memset(reserved, 0, sizeof(reserved)); }*/ } spinJPEGOption; /** * Options for saving JPEG 2000 images. Used in saving PPM images * with a call to spinImageSaveJpg2(). */ typedef struct _spinJPG2Option { /** JPEG saving quality in range (1-512). */ unsigned int quality; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinJPG2Option() { quality = 16; memset(reserved, 0, sizeof(reserved)); }*/ } spinJPG2Option; /** * Options for saving BMP images. Used in saving PPM images * with a call to spinImageSaveBmp(). */ typedef struct _spinBMPOption { bool8_t indexedColor_8bit; /** Reserved for future use. */ unsigned int reserved[16]; /* _spinBMPOption() { indexedColor_8bit = false; memset(reserved, 0, sizeof(reserved)); }*/ } spinBMPOption; /** * Options for saving MJPG videos. Used in saving MJPG videos * with a call to spinAVIRecorderOpenMJPG(). */ typedef struct _spinMJPGOption { /** Frame rate of the stream */ float frameRate; /** Image quality (1-100) */ unsigned int quality; unsigned int reserved[256]; /* _spinMJPGOption() { frameRate = 15.0; quality = 75; memset(reserved, 0, sizeof(reserved)); }*/ } spinMJPGOption; /** * Options for saving H264 videos. Used in saving H264 videos * with a call to spinAVIRecorderOpenH264(). */ typedef struct _spinH264Option { /** Frame rate of the stream */ float frameRate; /** Width of source image */ unsigned int width; /** Height of source image */ unsigned int height; /** Bitrate to encode at */ unsigned int bitrate; /** Reserved for future use */ unsigned int reserved[256]; /* _spinH264Option() { frameRate = 15.0; width = 0; height = 0; bitrate = 1000000; memset(reserved, 0, sizeof(reserved)); }*/ } spinH264Option; /** * Options for saving uncompressed videos. Used in saving AVI videos * with a call to spinAVIRecorderOpenUncompressed(). */ typedef struct _spinAVIOption { /** Frame rate of the stream */ float frameRate; /** Reserved for future use */ unsigned int reserved[256]; /* _spinAVIOption() { frameRate = 15.0; memset(reserved, 0, sizeof(reserved)); }*/ } spinAVIOption; /** * Provides easier access to the current version of Spinnaker. */ typedef struct _spinLibraryVersion { /** Major version of the library **/ unsigned int major; /** Minor version of the library **/ unsigned int minor; /** Version type of the library **/ unsigned int type; /** Build number of the library **/ unsigned int build; } spinLibraryVersion; /** * Possible Status Codes Returned from Action Command. */ typedef enum _actionCommandStatus { /** The device acknowledged the command. */ ACTION_COMMAND_STATUS_OK = 0, /* The device is not synchronized to a master clock to be used as time reference. Typically used when scheduled action commands cannot be scheduled for a future time since the reference time coming from IEEE 1588 is not locked. */ ACTION_COMMAND_STATUS_NO_REF_TIME = 0x8013, /* Returned when the scheduled action commands queue is full and the device cannot accept the additional request. */ ACTION_COMMAND_STATUS_OVERFLOW = 0x8015, /* The requested scheduled action command was requested at a point in time that is in the past. */ ACTION_COMMAND_STATUS_ACTION_LATE = 0x8016, /* Generic Error. Try enabling the Extended Status Code 2.0 bit on gvcp configuration register in order to receive more meaningful/detailed acknowledge messages from the device. */ ACTION_COMMAND_STATUS_ERROR = 0x8FFF } actionCommandStatus; /** * Action Command Result. */ typedef struct _actionCommandResult { /* IP Address of device that responded to Action Command */ unsigned int DeviceAddress; /* Action Command status return from device */ actionCommandStatus Status; } actionCommandResult; /*@}*/ /*@}*/ #endif // FLIR_SPINNAKER_DEFS_C_H