FLI libflipro API
/home/tom/projects/fli/libflipro/libflipro/libflipro.h
Go to the documentation of this file.
1 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 #ifndef _LIBFLIPRO_H_
20 #define _LIBFLIPRO_H_
22 
23 #ifdef __linux__
24 #include <wchar.h>
25 #include <stdarg.h>
26 #endif
27 #include "stdbool.h"
28 #include "stdint.h"
29 
30 // The following ifdef block is the standard way of creating macros which make exporting
31 // from a DLL simpler. All files within this DLL are compiled with the LIBFLIPRO_EXPORTS
32 // symbol defined on the command line. This symbol should not be defined on any project
33 // that uses this DLL. This way any other project whose source files include this file see
34 // LIBFLIPRO_API functions as being imported from a DLL, whereas this DLL sees symbols
35 // defined with this macro as being exported.
37 #if defined(_WIN32) || defined(_WINDOWS)
38 #ifdef LIBFLIPRO_EXPORTS
39 #define LIBFLIPRO_API __declspec(dllexport) int32_t
40 #define LIBFLIPRO_API_DATA __declspec(dllexport)
41 #define LIBFLIPRO_VOID __declspec(dllexport) void
42 #else
43 #ifdef _USRDLL
44 #define LIBFLIPRO_API __declspec(dllimport) int32_t
45 #define LIBFLIPRO_API_DATA __declspec(dllimport)
46 #define LIBFLIPRO_VOID __declspec(dllimport) void
47 #else
48 #define LIBFLIPRO_API int32_t
49 #define LIBFLIPRO_API_DATA
50 #define LIBFLIPRO_VOID void
51 #endif
52 
53 #endif
54 #endif
55 
56 #ifdef __linux__
57 #define LIBFLIPRO_API int32_t
58 #define LIBFLIPRO_API_DATA
59 #define LIBFLIPRO_VOID void
60 #endif
62 
64 // Typedefs, Defines, Macros
66 // Version information
68 #define FPRO_API_VERSION_MAJOR (2)
69 #define FPRO_API_VERSION_MINOR (1) // Should change if must change the Camera side as well
70 #define FPRO_API_VERSION_BUILD (4) // Minor changes not requiring Camera change
72 
73 //
74 // Some Helpful #defines
80 #define FPRO_IMAGE_FRAMEBYTES_TO_PIXELS(__framebytes) (((__framebytes) << 1) / 3)
85 #define FPRO_IMAGE_PIXELS_TO_FRAMEBYTES(__pixels) (((__pixels) & 0x1) ? ((((__pixels) * 3 ) >> 1) + 1) : (((__pixels) * 3 ) >> 1))
90 #define FPRO_IMAGE_DIMENSIONS_TO_FRAMEBYTES(__width,__height) FPRO_IMAGE_PIXELS_TO_FRAMEBYTES((__width) * (__height))
95 #define FPRO_REFERENCE_ROW_MAX (4094)
98 #define FPRO_THUMBNAIL_ROWS (512)
101 #define FPRO_THUMBNAIL_COLUMNS (512)
102 
131 
132 #ifdef __cplusplus
133 enum class FPRODEVICETYPE : unsigned int
134 #else
135 typedef enum
136 #endif
137 {
144  FPRO_CAM_DEVICE_TYPE_DC4320 = 0x03004320,
147  FPRO_CAM_DEVICE_TYPE_BIOLINE_420 = 0x05000420,
148  FPRO_CAM_DEVICE_TYPE_BIOLINE_455 = 0x05000455,
149  FPRO_CAM_DEVICE_TYPE_BIOLINE_492 = 0x05000492,
150  FPRO_CAM_DEVICE_TYPE_BIOLINE_530 = 0x05000530,
151  FPRO_CAM_DEVICE_TYPE_BIOLINE_533 = 0x05000533,
152  FPRO_CAM_DEVICE_TYPE_BIOLINE_541 = 0x05000541,
153  FPRO_CAM_DEVICE_TYPE_BIOLINE_571 = 0x05000571,
155 #ifdef __cplusplus
156 };
157 #else
159 #endif
160 
167 #define FPRO_USB_STRING_MAXLEN (256)
168 
175 #define FPRO_DEVICE_MAX_PATH_LENGTH (1024)
176 
193 #ifdef __cplusplus
194 enum class FPROCONNECTION
195 #else
196 typedef enum
197 #endif
198 {
202 #ifdef __cplusplus
203 };
204 #else
206 #endif
207 
208 
209 
227 #ifdef __cplusplus
228 enum class FPROUSBSPEED
229 #else
230 typedef enum
231 #endif
232 {
236 #ifdef __cplusplus
237 };
238 #else
240 #endif
241 
242 
259 typedef struct ip_info_t
260 {
261  uint32_t uiIPAddress;
262  uint32_t uiSpeed;
264 
277 typedef struct fibre_info_t
278 {
279  uint32_t uiChannelStatus;
280  uint64_t uiVersion;
282 
306 typedef struct con_info_t
307 {
309  uint32_t uiVendorId;
310  uint32_t uiProdId;
311  union
312  {
313  FPROUSBSPEED eUSBSpeed;
314  FPROFIBREINFO fibreInfo;
315  FPROIPINFO ipInfo;
316  } attr;
317 
319 
336 typedef struct host_if_info
337 {
338  uint32_t uiDriverVersion;
339  uint64_t uiHWVersion;
343 
364 typedef struct device_info_t
365 {
371 
372 
377 #define FPRO_VERSION_STRING_MAXLEN (32)
395 typedef struct device_version_info_t
396 {
402 
438 #ifdef __cplusplus
439 enum class FPROTESTIMAGETYPE
440 #else
441 typedef enum
442 #endif
443 {
452 #ifdef __cplusplus
453 };
454 #else
456 #endif
457 
458 
491 #ifdef __cplusplus
492 enum class FPROEXTTRIGTYPE
493 #else
494 typedef enum
495 #endif
496 {
501 #ifdef __cplusplus
502 };
503 #else
505 #endif
506 
526 typedef struct ext_trigger_info_t
527 {
530  bool bEnable;
532 
554 
555 
556 #define FPRO_DEBUG_NONE (0x00000000)
557 #define FPRO_DEBUG_ERROR (0x00000001)
558 #define FPRO_DEBUG_WARNING (0x00000002)
559 #define FPRO_DEBUG_INFO (0x00000004)
560 #define FPRO_DEBUG_REGRW (0x00000008)
561 #define FPRO_DEBUG_DEBUG (0x00000010)
562 #define FPRO_DEBUG_TRACE (0x00000020)
563 typedef unsigned int FPRODBGLEVEL;
564 
565 
566 
605 #ifdef __cplusplus
606 enum class FPROGPSSTATE
607 #else
608 typedef enum
609 #endif
610 {
615 
616 #ifdef __cplusplus
617 };
618 #else
620 #endif
621 
636 #ifdef __cplusplus
637 enum class FPROGPSOPT
638 #else
639 typedef enum
640 #endif
641 {
644 
645 #ifdef __cplusplus
646 };
647 #else
649 #endif
650 
651 
674 #ifdef __cplusplus
675 enum class FPROSENSREADCFG
676 #else
677 typedef enum
678 #endif
679 {
684  FPRO_SENSREAD_CB_ALL = 0x0F
685 #ifdef __cplusplus
686 };
687 #else
689 #endif
690 
691 //
696 #define FPRO_SENSOR_MODE_NAME_LENGTH (32)
697 
714 typedef struct sensor_mode_t
715 {
716  uint32_t uiModeIndex;
719 
720 
726 #define FPRO_GAIN_SCALE_FACTOR (1000)
727 
746 #ifdef __cplusplus
747 enum class FPROGAINTABLE
748 #else
749 typedef enum
750 #endif
751 {
754 
755  FPRO_GAIN_TABLE_CHANNEL_NUM,
756 #ifdef __cplusplus
757 };
758 #else
759 } FPROGAINTABLE;
760 #endif
761 
774 typedef struct gain_value_t
775 {
776  uint32_t uiValue;
777  uint32_t uiDeviceIndex;
779 
795 #ifdef __cplusplus
796 enum class FPROBLACKADJUSTCHAN
797 #else
798 typedef enum
799 #endif
800 {
803 #ifdef __cplusplus
804 };
805 #else
807 #endif
808 
852 #ifdef __cplusplus
853 enum class FPROCAPS : unsigned int
854 #else
855 typedef enum
856 #endif
857 {
876 
877  FPROCAP_NUM
878 
879 #ifdef __cplusplus
880 };
881 #else
883 #endif
884 
885 
909 #ifdef __cplusplus
910 enum class FPROCAPROI : unsigned int
911 #else
912 typedef enum
913 #endif
914 {
916  FPROCAP_ROI_BYROW = (0x00010000),
917  FPROCAP_ROI_BYROW_API_ONLY = (0x00020000),
918  FPROCAP_ROI_BYCOL = (0x00000001),
919  FPROCAP_ROI_BYCOL_API_ONLY = (0x00000002)
920 #ifdef __cplusplus
921 };
922 
923 
925 #define FPROCAP_ROI_BYCOL_ISCAM_SUPPORTED(__cap) ((__cap & 0xFFFF) == (uint32_t)FPROCAPROI::FPROCAP_ROI_BYCOL)
927 #define FPROCAP_ROI_BYCOL_ISAPI_SUPPORTED(__cap) ((__cap & 0xFFFF) == (uint32_t)FPROCAPROI::FPROCAP_ROI_BYCOL_API_ONLY)
929 #define FPROCAP_ROI_BYROW_ISCAM_SUPPORTED(__cap) ((__cap & 0xFFFF0000) == (uint32_t)FPROCAPROI::FPROCAP_ROI_BYROW)
931 #define FPROCAP_ROI_BYROW_ISAPI_SUPPORTED(__cap) ((__cap & 0xFFFF0000) == (uint32_t)FPROCAPROI::FPROCAP_ROI_BYROW_API_ONLY)
932 #else
935 #define FPROCAP_ROI_BYCOL_ISCAM_SUPPORTED(__cap) ((__cap & 0xFFFF) == (uint32_t)FPROCAP_ROI_BYCOL)
937 #define FPROCAP_ROI_BYCOL_ISAPI_SUPPORTED(__cap) ((__cap & 0xFFFF) == (uint32_t)FPROCAP_ROI_BYCOL_API_ONLY)
939 #define FPROCAP_ROI_BYROW_ISCAM_SUPPORTED(__cap) ((__cap & 0xFFFF0000) == (uint32_t)FPROCAP_ROI_BYROW)
941 #define FPROCAP_ROI_BYROW_ISAPI_SUPPORTED(__cap) ((__cap & 0xFFFF0000) == (uint32_t)FPROCAP_ROI_BYROW_API_ONLY)
942 #endif
943 
944 
945 
946 
972 #ifdef __cplusplus
973 enum class FPROHDR
974 #else
975 typedef enum
976 #endif
977 {
981 #ifdef __cplusplus
982 };
983 #else
984 } FPROHDR;
985 #endif
986 
987 
988 
989 // Auxiliary I/O
1007 #ifdef __cplusplus
1008 enum class FPROAUXIO
1009 #else
1010 typedef enum
1011 #endif
1012 {
1017 #ifdef __cplusplus
1018 };
1019 #else
1020 } FPROAUXIO;
1021 #endif
1022 
1036 #ifdef __cplusplus
1037 enum class FPROAUXIO_DIR
1038 #else
1039 typedef enum
1040 #endif
1041 {
1044 #ifdef __cplusplus
1045 };
1046 #else
1047 } FPROAUXIO_DIR;
1048 #endif
1049 
1063 #ifdef __cplusplus
1064 enum class FPROAUXIO_STATE
1065 #else
1066 typedef enum
1067 #endif
1068 {
1071 #ifdef __cplusplus
1072 };
1073 #else
1074 } FPROAUXIO_STATE;
1075 #endif
1076 
1077 
1093 #ifdef __cplusplus
1094 enum class FPROAUXIO_EXPACTIVETYPE
1095 #else
1096 typedef enum
1097 #endif
1098 {
1102  FPRO_AUXIO_EXPTYPE_RESERVED,
1103 
1104  FPRO_AUXIO_EXPTYPE_NOTSET
1105 #ifdef __cplusplus
1106 };
1107 #else
1109 #endif
1110 
1111 
1135 #ifdef __cplusplus
1136 enum class FPROSTREAMERSTATUS
1137 #else
1138 typedef enum
1139 #endif
1140 {
1144 
1145 #ifdef __cplusplus
1146 };
1147 #else
1149 #endif
1150 
1151 
1183 typedef struct fpro_stream_stats_t
1184 {
1193  uint32_t uiReserved;
1195 
1209 {
1210  uint32_t uiFrameNumber;
1213 
1235 #ifdef __cplusplus
1236 enum class FPRO_FRAME_TYPE
1237 #else
1238 typedef enum
1239 #endif
1240 {
1246 #ifdef __cplusplus
1247 };
1248 #else
1249 } FPRO_FRAME_TYPE;
1250 #endif
1251 
1267 #ifdef __cplusplus
1268 enum class FPROCMS
1269 #else
1270 typedef enum
1271 #endif
1272 {
1276 #ifdef __cplusplus
1277 };
1278 #else
1279 } FPROCMS;
1280 #endif
1281 
1282 
1320 typedef struct ref_frames_t
1321 {
1322  uint32_t uiWidth;
1323  uint32_t uiHeight;
1324 
1330 
1331 
1344 #ifdef __cplusplus
1345 enum class FPRO_IMAGE_FORMAT
1346 #else
1347 typedef enum
1348 #endif
1349 {
1350  IFORMAT_NONE = 0,
1353  IFORMAT_FITS
1354 #ifdef __cplusplus
1355 };
1356 #else
1358 #endif
1359 
1360 
1458 #ifdef __cplusplus
1459 enum class FPRO_PIXEL_FORMAT
1460 #else
1461 typedef enum
1462 #endif
1463 {
1469 
1475 
1476  PFORMAT_MONO12_KEPLER,
1487 
1488  PFORMAT_MONO16_KEPLER,
1496 
1500 
1505 
1512 
1513  PFORMAT_UNKNOWN
1514 #ifdef __cplusplus
1515 };
1516 #else
1518 #endif
1519 
1520 
1537 typedef struct conv_info_t
1538 {
1540  wchar_t* pDSNUFile;
1541  wchar_t* pPRNUFile;
1543 
1559 #ifdef __cplusplus
1560 enum class FPRO_HWMERGEFRAMES
1561 #else
1562 typedef enum
1563 #endif
1564 {
1568 
1569 #ifdef __cplusplus
1570 };
1571 #else
1573 #endif
1574 
1575 
1606 typedef struct hw_merge_enables_t
1607 {
1612 
1613 
1670 typedef struct unpacked_images_t
1671 {
1672  uint32_t uiMetaDataSize;
1674 
1675  uint8_t *pLowMetaData;
1676  uint16_t *pLowImage;
1677  uint64_t uiLowImageSize;
1680 
1681  uint8_t *pHighMetaData;
1682  uint16_t *pHighImage;
1686 
1688  uint16_t *pMergedImage;
1692 
1694 
1695 
1697 
1710 typedef struct int_point_t
1711 {
1712  int32_t X;
1713  int32_t Y;
1715 
1728 typedef struct pixel_info_t
1729 {
1731  uint32_t uiValue;
1733 
1760 typedef struct image_plane_stats_t
1761 {
1762  uint32_t uiLCutoff;
1763  uint32_t uiUCutoff;
1765  double *pdblHistogram;
1766  double dblMean;
1767  double dblMedian;
1768  double dblMode;
1770 
1773 
1775 
1796 typedef struct unpacked_stats_t
1797 {
1800 
1803 
1806 
1808 
1818 #ifdef __cplusplus
1819 enum class FPRO_META_KEYS
1820 #else
1821 typedef enum
1822 #endif
1823 {
1824  META_KEY_MAGIC,
1825  META_KEY_META_DATA_LENGTH,
1826  META_KEY_META_DATA_VERSION,
1827 
1828  META_KEY_BACK_SIDE_ILLUMINATED,
1829  META_KEY_BASE_TEMPERATURE,
1830  META_KEY_BINNING_X,
1831  META_KEY_BINNING_Y,
1832  META_KEY_BLACK_LEVEL_ADJUST,
1833  META_KEY_BLACK_SUN_ADJUST,
1834  META_KEY_BLACK_LEVEL_HIGH_ADJUST,
1835  META_KEY_BLACK_SUN_HIGH_ADJUST,
1836  META_KEY_CAMERA_MODEL,
1838  META_KEY_CAPTURE_TIME_SECS,
1839  META_KEY_CAPTURE_TIME_NSECS,
1840  META_KEY_COOLER_TEMPERATURE,
1841  META_KEY_COOLER_DUTY_CYCLE,
1842  META_KEY_CONTROL_BLOCK,
1843  META_KEY_CORRELATED_MULTIPLE_SAMPLE,
1844  META_KEY_DATA_PIXEL_BIT_DEPTH,
1845  META_KEY_DATA_ZERO_POINT,
1846  META_KEY_DEAD_PIXEL_CORRECTION,
1847  META_KEY_EXPOSURE_TIME,
1848  META_KEY_FILE_CREATE_TIME,
1849  META_KEY_FPGA_TEMPERATURE,
1850  META_KEY_FRAME_NUMBER,
1851  META_KEY_GAIN_LOW,
1852  META_KEY_GAIN_GLOBAL,
1853  META_KEY_GAIN_HIGH,
1854  META_KEY_GEO_LAT_RAW,
1855  META_KEY_GEO_LAT_DEGREES,
1856  META_KEY_GEO_LAT_MINUTES,
1857  META_KEY_GEO_LAT_NORTH,
1858  META_KEY_GEO_LONG_RAW,
1859  META_KEY_GEO_LONG_DEGREES,
1860  META_KEY_GEO_LONG_MINUTES,
1861  META_KEY_GEO_LONG_EAST,
1862  META_KEY_GLOBAL_RESET,
1863  META_KEY_GPS_ERROR,
1864  META_KEY_GPS_LOCK,
1865  META_KEY_HDR_MODE,
1866  META_KEY_HIGH_ADUE,
1867  META_KEY_HORIZONTAL_PIXELS,
1868  META_KEY_HORIZONTAL_PIXEL_SIZE,
1869  META_KEY_HORIZONTAL_SCAN_DIRECTION_INVERT,
1870  META_KEY_ILLUMINATION_START_DELAY,
1871  META_KEY_ILLUMINATION_STOP_DELAY,
1872  META_KEY_IMAGE_HEIGHT,
1873  META_KEY_IMAGE_MODE,
1874  META_KEY_IMAGE_START_COLUMN,
1875  META_KEY_IMAGE_START_ROW,
1876  META_KEY_IMAGE_STOP_COLUMN,
1877  META_KEY_IMAGE_STOP_ROW,
1878  META_KEY_IMAGE_START_EXPOSURE_ROW,
1879  META_KEY_IMAGE_TYPE,
1880  META_KEY_IMAGE_WIDTH,
1881  META_KEY_IS_HIGH_FRAME,
1882  META_KEY_IS_HIGH_GAIN_ONLY_FRAME,
1883  META_KEY_IS_MERGED_FRAME,
1884  META_KEY_IS_SOFTWARE_BINNING,
1885  META_KEY_IS_STACKED_FRAME,
1886  META_KEY_LOW_DARK_CURRENT,
1887  META_KEY_LOW_NOISE,
1888  META_KEY_MERGE_GAIN_RATIO,
1889  META_KEY_MERGE_LINE_OFFSET,
1890  META_KEY_NON_ROW_ALLIGNED_IMAGE,
1891  META_KEY_NUM_OF_DATA_CHANNELS,
1892  META_KEY_PIXEL_ORDERED_IMAGE,
1893  META_KEY_POST_REFERENCE_ROW,
1894  META_KEY_PRE_REFERENCE_ROW,
1895  META_KEY_POST_REFERENCE_PIXELS_PER_ROW,
1896  META_KEY_PRE_REFERENCE_PIXELS_PER_ROW,
1897  META_KEY_SENSOR_PIXEL_BIT_DEPTH,
1898  META_KEY_SENSOR_READ_QUADRANTS,
1899  META_KEY_SENSOR_CHIP_TEMPERATURE,
1900  META_KEY_SERIAL_NUMBER,
1901  META_KEY_SHUTTER_CLOSE_DELAY,
1902  META_KEY_SHUTTER_OPEN_DELAY,
1903  META_KEY_TEMPERATURE_SETPOINT,
1904  META_KEY_TEST_HIGH_GAIN_ABSOLUTE,
1905  META_KEY_TEST_LOW_GAIN_ABSOLUTE,
1906  META_KEY_TRACKING_FRAMES_PER_IMAGE,
1907  META_KEY_TRACKING_START_COLUMN,
1908  META_KEY_TRACKING_START_ROW,
1909  META_KEY_TRACKING_STOP_COLUMN,
1910  META_KEY_TRACKING_STOP_ROW,
1911  META_KEY_USE_SHIFTED_AVERAGING,
1912  META_KEY_VERSION_API,
1913  META_KEY_VERSION_APPLICATION,
1914  META_KEY_VERSION_FIRMWARE,
1915  META_KEY_VERTICAL_PIXELS,
1916  META_KEY_VERTICAL_PIXEL_SIZE,
1917  META_KEY_VERTICAL_SCAN_DIRECTION_INVERT,
1918 
1919  META_KEY_V4IMAGE_OFFSET,
1920  META_KEY_V4META_INFO,
1921  META_KEY_V4PIXEL_FORMAT,
1922  META_KEY_V4OTHER_TYPE,
1923  META_KEY_V4OTHER_TYPE_LENGTH,
1924  META_KEY_V4OTHER_TYPE_OFFSET,
1925  META_KEY_V4RESERVED,
1926 
1927  META_KEY_NUM
1928 
1929 #ifdef __cplusplus
1930 };
1931 #else
1932 } FPRO_META_KEYS;
1933 #endif
1934 
1935 
1937 #define FPRO_META_VALUE_STRING_LENGTH_MAX (64)
1938 
1957 typedef struct meta_data_value_t
1958 {
1959  double dblValue;
1960  int32_t iByteLength;
1962 
1964 
1966 // Camera Open, Close
1991 LIBFLIPRO_API FPROCam_GetCameraList(FPRODEVICEINFO *pDeviceInfo, uint32_t *pNumDevices);
1992 
2004 LIBFLIPRO_API FPROCam_GetDeviceInfo(int32_t iHandle, FPRODEVICEINFO* pDeviceInfo);
2005 
2019 LIBFLIPRO_API FPROCam_Open(FPRODEVICEINFO *pDevInfo, int32_t *pHandle);
2020 
2021 
2029 LIBFLIPRO_API FPROCam_Close(int32_t iHandle);
2030 
2043 LIBFLIPRO_API FPROCam_GetAPIVersion(wchar_t *pVersion, uint32_t uiLength);
2044 
2053 LIBFLIPRO_API FPROCam_GetDeviceVersion(int32_t iHandle, FPRODEVICEVERS *pVersion);
2054 
2064 LIBFLIPRO_API FPROCam_GetHostInterfaceInfo(FPROHOSTINFO *pHostInfo, uint32_t *pNum);
2065 
2066 
2069 // Frame Data Functions
2085 LIBFLIPRO_API FPROFrame_CaptureAbort(int32_t iHandle);
2086 
2104 //LIBFLIPRO_API FPROFrame_CaptureEnd(int32_t iHandle);
2106 
2130 LIBFLIPRO_API FPROFrame_CaptureStart(int32_t iHandle, uint32_t uiFrameCount);
2131 
2152 LIBFLIPRO_API FPROFrame_CaptureStop(int32_t iHandle);
2153 
2154 
2167 LIBFLIPRO_API FPROFrame_CaptureThumbnail(int32_t iHandle);
2168 
2181 
2191 LIBFLIPRO_API FPROFrame_ComputeFrameSize(int32_t iHandle);
2192 
2193 
2210 LIBFLIPRO_API FPROFrame_ComputeFrameSizePixels(int32_t iHandle, uint32_t *pTotalWidth, uint32_t *pTotalHeight);
2211 
2222 
2233 
2246 LIBFLIPRO_API FPROFrame_GetDummyPixelEnable(int32_t iHandle, bool *pEnable);
2247 
2262 LIBFLIPRO_API FPROFrame_GetFrameReferenceRows(int32_t iHandle, uint32_t* pPreRows, uint32_t* pPostRows);
2263 
2277 LIBFLIPRO_API FPROFrame_GetFrameType(int32_t iHandle, FPRO_FRAME_TYPE *pType);
2278 
2279 
2296 LIBFLIPRO_API FPROFrame_GetImageDataEnable(int32_t iHandle, bool *pEnable);
2297 
2314 LIBFLIPRO_API FPROFrame_GetTestImageEnable(int32_t iHandle, bool *pEnable, FPROTESTIMAGETYPE *pFormat);
2315 
2329 LIBFLIPRO_API FPROFrame_GetImageArea(int32_t iHandle, uint32_t *pColOffset, uint32_t *pRowOffset, uint32_t *pWidth, uint32_t *pHeight);
2330 
2342 LIBFLIPRO_API FPROFrame_GetPixelFormat(int32_t iHandle, FPRO_PIXEL_FORMAT* pFormat, uint32_t* pPixelLSB);
2343 
2362 LIBFLIPRO_API FPROFrame_GetSupportedPixelFormats(int32_t iHandle, FPRO_PIXEL_FORMAT* pFormats, uint32_t* pNumFormats);
2363 
2379 LIBFLIPRO_API FPROFrame_GetThumbnailFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize);
2380 
2420 LIBFLIPRO_API FPROFrame_GetVideoFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS);
2421 
2422 
2476 LIBFLIPRO_API FPROFrame_GetVideoFrameUnpacked(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats);
2477 
2507 LIBFLIPRO_API FPROFrame_GetVideoFrameExt(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize);
2508 
2509 
2529 LIBFLIPRO_API FPROFrame_GetVideoFrameUnpackedExt(int32_t iHandle, uint8_t* pFrameData, uint32_t* pSize, FPROUNPACKEDIMAGES* pUPBuffers, FPROUNPACKEDSTATS* pStats);
2530 
2555 LIBFLIPRO_API FPROFrame_UnpackFile(wchar_t* pFileName, FPROUNPACKEDIMAGES* pUPBuffers, FPROUNPACKEDSTATS* pStats);
2556 
2575 LIBFLIPRO_API FPROFrame_UnpackFileEx(wchar_t* pFileName, FPROUNPACKEDIMAGES* pUPBuffers, FPROUNPACKEDSTATS* pStats, const wchar_t* pDSNUFile, const wchar_t* pPRNUFile);
2576 
2577 
2597 LIBFLIPRO_API FPROFrame_ConvertFile(wchar_t* pInRcdFile, FPRO_CONV* pConvInfo, wchar_t *pOutFile);
2602 
2618 LIBFLIPRO_API FPROFrame_MetaDataToString(wchar_t* pFileName, wchar_t *pMetaString, uint32_t uiMaxChars);
2619 
2635 LIBFLIPRO_API FPROFrame_MetaDataToStringBin(uint8_t *pImageData, uint32_t uiImageSizeBytes, wchar_t* pMetaString, uint32_t uiMaxChars);
2636 
2650 LIBFLIPRO_API FPROFrame_MetaValueInit(wchar_t* pFileName);
2651 
2666 LIBFLIPRO_API FPROFrame_MetaValueInitBin(uint8_t* pMetaData, uint32_t uiLength);
2667 
2681 LIBFLIPRO_API FPROFrame_MetaValueGet(FPRO_META_KEYS eMetaKey, FPROMETAVALUE* pMetaValue);
2682 
2699 LIBFLIPRO_API FPROFrame_MetaValueGetNext(FPROMETAVALUE* pMetaValue);
2700 
2719 //DEPRECATED - REMOVED
2720 //LIBFLIPRO_API FPROFrame_IsAvailable(int32_t iHandle, bool *pAvailable);
2721 
2736 LIBFLIPRO_API FPROFrame_SetDummyPixelEnable(int32_t iHandle, bool bEnable);
2737 
2752 LIBFLIPRO_API FPROFrame_SetFrameReferenceRows(int32_t iHandle, uint32_t uiPreRows, uint32_t uiPostRows);
2753 
2767 LIBFLIPRO_API FPROFrame_SetFrameType(int32_t iHandle, FPRO_FRAME_TYPE eType);
2768 
2781 LIBFLIPRO_API FPROFrame_SetImageDataEnable(int32_t iHandle, bool bEnable);
2782 
2797 LIBFLIPRO_API FPROFrame_SetTestImageEnable(int32_t iHandle, bool bEnable, FPROTESTIMAGETYPE eFormat);
2798 
2815 LIBFLIPRO_API FPROFrame_SetTrackingArea(int32_t iHandle, uint32_t uiStartRow, uint32_t uiEndRow);
2816 
2831 LIBFLIPRO_API FPROFrame_SetTrackingAreaEnable (int32_t iHandle, uint32_t uiNumTrackingFrames);
2832 
2845 LIBFLIPRO_API FPROFrame_SetPixelFormat(int32_t iHandle, FPRO_PIXEL_FORMAT pfPixelFormat, uint32_t uiPixelLSB);
2846 
2860 LIBFLIPRO_API FPROFrame_SetImageArea(int32_t iHandle, uint32_t uiColOffset, uint32_t uiRowOffset, uint32_t uiWidth, uint32_t uiHeight);
2861 
2882 LIBFLIPRO_API FPROFrame_StreamInitialize(int32_t iHandle, uint32_t uiFrameSizeBytes, wchar_t *pRootPath, wchar_t *pFilePrefix);
2883 
2894 LIBFLIPRO_API FPROFrame_StreamDeinitialize(int32_t iHandle);
2895 
2919 LIBFLIPRO_API FPROFrame_StreamStart(int32_t iHandle,uint32_t uiFrameCount,uint64_t uiFrameIntervalMS);
2920 
2930 LIBFLIPRO_API FPROFrame_StreamStop(int32_t iHandle);
2931 
2942 LIBFLIPRO_API FPROFrame_StreamGetStatistics(int32_t iHandle, FPROSTREAMSTATS *pStats);
2943 
2967 LIBFLIPRO_API FPROFrame_StreamGetPreviewImage(int32_t iHandle, uint8_t* pImage, uint32_t* pLength, uint32_t uiTimeoutMSecs);
2968 
2969 
2988 LIBFLIPRO_API FPROFrame_StreamGetPreviewImageEx(int32_t iHandle, uint8_t* pImage, uint32_t* pLength, FPROPREVIEW *pInfo, uint32_t uiTimeoutMSecs);
2989 
2990 
2993 // Control Functions
2996 
3007 LIBFLIPRO_API FPROCtrl_GetBurstModeEnable(int32_t iHandle, bool *pEnable);
3008 
3017 LIBFLIPRO_API FPROCtrl_GetCoolerDutyCycle(int32_t iHandle, uint32_t *pDutyCycle);
3018 
3046 LIBFLIPRO_API FPROCtrl_GetCameraBufferBypass(int32_t iHandle, bool* pCameraBypassEnable, bool* pHostBypassEnable);
3047 
3064 LIBFLIPRO_API FPROCtrl_GetElectricallyBlackPixelEnable(int32_t iHandle, bool* pEnable);
3065 
3098 LIBFLIPRO_API FPROCtrl_GetExposure(int32_t iHandle, uint64_t *pExposureTime, uint64_t *pFrameDelay, bool *pImmediate);
3099 
3100 
3109 LIBFLIPRO_API FPROCtrl_GetExternalTriggerEnable(int32_t iHandle, FPROEXTTRIGINFO* pTrigInfo);
3110 
3111 
3120 LIBFLIPRO_API FPROCtrl_GetFanEnable(int32_t iHandle, bool *pOn);
3121 
3133 LIBFLIPRO_API FPROCtrl_GetGPSState(int32_t iHandle, FPROGPSSTATE* pState, uint32_t* pOptions);
3134 
3143 LIBFLIPRO_API FPROCtrl_GetHeaterPower(int32_t iHandle, uint32_t *pPwrPercentage);
3144 
3155 LIBFLIPRO_API FPROCtrl_GetIlluminationDelay(int32_t iHandle, uint32_t *pOnDelay, uint32_t *pOffDelay);
3156 
3165 LIBFLIPRO_API FPROCtrl_GetIlluminationOn(int32_t iHandle, bool *pOn);
3166 
3178 LIBFLIPRO_API FPROCtrl_GetLED(int32_t iHandle, bool *pOn);
3179 
3200 LIBFLIPRO_API FPROCtrl_GetLEDDuration(int32_t iHandle, uint32_t *pDurationUsec);
3201 
3221 LIBFLIPRO_API FPROCtrl_GetPCIETemperatures(int32_t iHandle, double* pPcieFpga, double *pFibreFpga);
3222 
3237 LIBFLIPRO_API FPROCtrl_GetSensorTemperature(int32_t iHandle, int32_t *pTemp);
3238 
3250 LIBFLIPRO_API FPROCtrl_GetSensorTemperatureReadEnable(int32_t iHandle, bool *pEnable);
3251 
3252 
3267 LIBFLIPRO_API FPROCtrl_GetShutterOpen(int32_t iHandle, bool *pOpen);
3268 
3283 LIBFLIPRO_API FPROCtrl_GetShutterOverride(int32_t iHandle, bool *pOverride);
3284 
3301 LIBFLIPRO_API FPROCtrl_GetTemperatures(int32_t iHandle, double *pOtherTemp, double *pBaseTemp, double *pCoolerTemp);
3302 
3311 LIBFLIPRO_API FPROCtrl_GetTemperatureSetPoint(int32_t iHandle, double *pSetPoint);
3312 
3331 LIBFLIPRO_API FPROCtrl_SetBurstModeEnable(int32_t iHandle, bool bEnable);
3332 
3351 LIBFLIPRO_API FPROCtrl_SetCameraBufferBypass(int32_t iHandle, bool bCameraBypassEnable, bool bHostBypassEnable);
3352 
3366 LIBFLIPRO_API FPROCtrl_SetElectricallyBlackPixelEnable(int32_t iHandle, bool bEnable);
3367 
3403 LIBFLIPRO_API FPROCtrl_SetExposure(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate);
3404 
3444 LIBFLIPRO_API FPROCtrl_SetExposureEx(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate, uint64_t* pActualExposureTime, uint64_t* pActualFrameDelay);
3445 
3455 LIBFLIPRO_API FPROCtrl_SetExternalTriggerEnable(int32_t iHandle, uint32_t uiFrameCount, FPROEXTTRIGINFO *pTrigInfo);
3456 
3465 LIBFLIPRO_API FPROCtrl_SetFanEnable(int32_t iHandle, bool bOn);
3466 
3476 LIBFLIPRO_API FPROCtrl_SetGPSOptions(int32_t iHandle, uint32_t uiOptions);
3477 
3486 LIBFLIPRO_API FPROCtrl_SetHeaterPower(int32_t iHandle,uint32_t uiPwrPercentage);
3487 
3501 LIBFLIPRO_API FPROCtrl_SetIlluminationDelay(int32_t iHandle, uint16_t uiOnDelay, uint16_t uiOffDelay);
3502 
3511 LIBFLIPRO_API FPROCtrl_SetIlluminationOn(int32_t iHandle, bool bOn);
3512 
3527 LIBFLIPRO_API FPROCtrl_SetLED(int32_t iHandle, bool bOn);
3528 
3548 LIBFLIPRO_API FPROCtrl_SetLEDDuration(int32_t iHandle, uint32_t uiDurationUSec);
3549 
3568 LIBFLIPRO_API FPROCtrl_SetSensorTemperatureReadEnable(int32_t iHandle, bool bEnable);
3569 
3570 
3585 LIBFLIPRO_API FPROCtrl_SetShutterOpen(int32_t iHandle, bool bOpen);
3586 
3599 LIBFLIPRO_API FPROCtrl_SetShutterOverride(int32_t iHandle, bool bOverride);
3600 
3609 LIBFLIPRO_API FPROCtrl_SetTemperatureSetPoint(int32_t iHandle, double dblSetPoint);
3610 
3612 // Sensor Functions
3625 LIBFLIPRO_API FPROSensor_GetBinning(int32_t iHandle, uint32_t *pXBin, uint32_t *pYBin);
3626 
3657 LIBFLIPRO_API FPROSensor_GetBinningTable(int32_t iHandle, uint32_t *pBinTable, uint32_t *pTableSizeBytes);
3658 
3675 LIBFLIPRO_API FPROSensor_GetBlackLevelAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue);
3676 
3693 LIBFLIPRO_API FPROSensor_GetBlackSunAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue);
3694 
3713 LIBFLIPRO_API FPROSensor_GetCapabilityList(int32_t iHandle, uint32_t* pCapList, uint32_t* pNumCaps);
3714 
3727 LIBFLIPRO_API FPROSensor_GetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t *pGainIndex);
3728 
3746 LIBFLIPRO_API FPROSensor_GetGainTable(int32_t iHandle, FPROGAINTABLE eTable, FPROGAINVALUE *pGainValues, uint32_t *pNumEntries);
3747 
3758 LIBFLIPRO_API FPROSensor_GetHDREnable(int32_t iHandle, FPROHDR* pHDREnable);
3759 
3760 
3773 LIBFLIPRO_API FPROSensor_GetHighGainOnlyEnable(int32_t iHandle, bool *pHighGainOnly);
3774 
3786 LIBFLIPRO_API FPROSensor_GetMode(int32_t iHandle, uint32_t uiModeIndex, FPROSENSMODE *pMode);
3787 
3800 LIBFLIPRO_API FPROSensor_GetModeCount(int32_t iHandle, uint32_t *pCount,uint32_t *pCurrentMode);
3801 
3814 LIBFLIPRO_API FPROSensor_GetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG *pReadCfg);
3815 
3828 LIBFLIPRO_API FPROSensor_GetSamplesPerPixel(int32_t iHandle, FPROCMS *pSamplesPerPixel);
3829 
3839 LIBFLIPRO_API FPROSensor_GetScanDirection(int32_t iHandle, bool *pHInverted,bool *pVInverted);
3840 
3850 LIBFLIPRO_API FPROSensor_GetTrainingEnable(int32_t iHandle, bool *pEnable);
3851 
3865 LIBFLIPRO_API FPROSensor_SetAnalogGain(int32_t iHandle, int32_t iGainValue);
3866 
3876 LIBFLIPRO_API FPROSensor_SetBinning(int32_t iHandle, uint32_t uiXBin, uint32_t uiYBin);
3877 
3893 LIBFLIPRO_API FPROSensor_SetBlackLevelAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue);
3894 
3910 LIBFLIPRO_API FPROSensor_SetBlackSunAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue);
3911 
3922 LIBFLIPRO_API FPROSensor_SetHDREnable(int32_t iHandle, FPROHDR eHDREnable);
3923 
3936 LIBFLIPRO_API FPROSensor_SetHighGainOnlyEnable(int32_t iHandle, bool bHighGainOnly);
3937 
3956 LIBFLIPRO_API FPROSensor_SetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t uiGainIndex);
3957 
3966 LIBFLIPRO_API FPROSensor_SetMode(int32_t iHandle, uint32_t uiModeIndex);
3967 
3981 LIBFLIPRO_API FPROSensor_SetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG eReadCfg);
3982 
3995 LIBFLIPRO_API FPROSensor_SetSamplesPerPixel(int32_t iHandle, FPROCMS eSamplesPerPixel);
3996 
4006 LIBFLIPRO_API FPROSensor_SetScanDirection(int32_t iHandle, bool bHInverted, bool bVInverted);
4007 
4017 LIBFLIPRO_API FPROSensor_SetTrainingEnable(int32_t iHandle, bool bEnable);
4018 
4019 
4021 // Auxiliary I/O Support Functions
4037 LIBFLIPRO_API FPROAuxIO_GetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR *pDirection, FPROAUXIO_STATE *pState);
4038 
4056 LIBFLIPRO_API FPROAuxIO_GetExposureActiveType(int32_t iHandle, FPROAUXIO ePin, FPROAUXIO_EXPACTIVETYPE *pType, bool* pActiveHigh);
4057 
4071 LIBFLIPRO_API FPROAuxIO_SetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR eDirection, FPROAUXIO_STATE eState);
4072 
4090 LIBFLIPRO_API FPROAuxIO_SetExposureActiveType(int32_t iHandle, FPROAUXIO ePin, FPROAUXIO_EXPACTIVETYPE eType, bool bActiveHigh);
4091 
4092 
4094 // Frame Acknowledgment Mode Support Functions
4117 LIBFLIPRO_API FPROFAck_GetEnable(int32_t iHandle, bool *pEnable);
4118 
4131 LIBFLIPRO_API FPROFAck_SetEnable(int32_t iHandle, bool bEnable);
4132 
4143 LIBFLIPRO_API FPROFAck_FrameAcknowledge(int32_t iHandle);
4144 
4145 
4162 LIBFLIPRO_API FPROFAck_FrameResend(int32_t iHandle);
4163 
4176 LIBFLIPRO_API FPROFAck_FlushImageQueue(int32_t iHandle);
4177 
4197 LIBFLIPRO_API FPROAlgo_StackInitialize(int32_t iHandle);
4198 
4219 LIBFLIPRO_API FPROAlgo_StackNextFrame(int32_t iHandle, uint8_t* pFrameData, uint32_t* pSize, uint32_t uiTimeoutMS);
4220 
4253 LIBFLIPRO_API FPROAlgo_StackFinish(int32_t iHandle, uint16_t **ppLowMeanFrame, uint16_t **ppHighMeanFrame, uint32_t* pNumPixels, uint8_t** ppMetaData, uint32_t* puiMetaSize);
4254 
4268 LIBFLIPRO_API FPROAlgo_StackDeinitialize(int32_t iHandle);
4269 
4292 
4297 LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFrames(int32_t iHandle, FPRO_REFFRAMES* pRefFrames);
4298 
4324 LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFiles(int32_t iHandle, const wchar_t *pDSNUFile, const wchar_t *pPRNUFile);
4325 
4339 LIBFLIPRO_API FPROAlgo_GetHardwareMergeThresholds(int32_t iHandle, uint16_t *pHighGainThreshold, uint16_t*pMergeDifferenceThreshold);
4340 
4356 LIBFLIPRO_API FPROAlgo_SetHardwareMergeThresholds(int32_t iHandle, uint16_t uiHighGainThreshold, uint16_t uiMergeDifferenceThreshold);
4357 
4370 LIBFLIPRO_API FPROAlgo_GetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE *pMergeEnables);
4371 
4372 
4385 LIBFLIPRO_API FPROAlgo_SetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE mergeEnables);
4386 
4387 
4389 //LIBFLIPRO_API FPROAlgo_MergeRcdToFits(wchar_t *pRCDFileName, wchar_t *pDSNURef, wchar_t *pPRNURef);
4391 
4393 // NV Storage Functions
4416 LIBFLIPRO_API FPRONV_WriteNVStorage(int32_t iHandle,uint32_t uiOffset, uint8_t *pData, uint32_t uiLength);
4417 
4432 LIBFLIPRO_API FPRONV_ReadNVStorage(int32_t iHandle, uint32_t uiOffset, uint8_t *pData, uint32_t uiLength);
4433 
4435 // Low level commands and functions
4438 LIBFLIPRO_API FPROCmd_SendRaw(int32_t iHandle, uint8_t *pData, uint32_t uiLength);
4440 LIBFLIPRO_API FPROCmd_RecvRaw(int32_t iHandle, uint8_t* pRxData, uint32_t* pRxLength);
4442 LIBFLIPRO_API FPROCmd_SendRecvRaw(int32_t iHandle, uint8_t *pTxData, uint32_t uiTxLength, uint8_t *pRxData, uint32_t *pRxLength);
4444 LIBFLIPRO_API FPROCmd_ReadReg(int32_t iHandle, uint32_t uiReg, uint32_t *pValue);
4446 LIBFLIPRO_API FPROCmd_WriteReg(int32_t iHandle, uint32_t uiReg, uint32_t uiValue, uint32_t uiMask);
4448 LIBFLIPRO_API FPROCmd_ReadDeviceReg(int32_t iHandle, uint32_t uiDevId, uint32_t uiReg, uint32_t* pValue);
4450 LIBFLIPRO_API FPROCmd_ReadDeviceRegEx(int32_t iHandle, uint32_t uiDevId, uint32_t uiReg, uint8_t* pRxData, uint32_t *pRxLength);
4452 LIBFLIPRO_API FPROCmd_WriteDeviceReg(int32_t iHandle, uint32_t uiDevId, uint32_t uiReg, uint32_t uiValue, uint32_t uiMask);
4454 LIBFLIPRO_API FPROCmd_PCIEReadReg(int32_t iHandle, uint32_t uiReg, uint32_t* pValue);
4456 LIBFLIPRO_API FPROCmd_PCIEWriteReg(int32_t iHandle, uint32_t uiReg, uint32_t uiValue);
4458 LIBFLIPRO_API FPROCmd_ReadSensorReg(int32_t iHandle, uint32_t uiChipId, uint32_t uiReg, uint32_t* pValue);
4460 LIBFLIPRO_API FPROCmd_WriteSensorReg(int32_t iHandle, uint32_t uiChipId, uint32_t uiReg, uint32_t uiValue, uint32_t uiMask);
4461 
4462 // Debug Functions
4464 // Conversion strings to aid in debug printing
4465 // The Linux part is different because of the way
4466 // swprintf() works- when %s is used, the argument is
4467 // assumed to be a char pointer. Hence we do not make it wide.
4468 #if defined(WIN32) || defined(_WINDOWS)
4469 #define STRINGIFY(x) L##x
4470 #define MAKEWIDE(x) STRINGIFY(x)
4471 #else
4472 #define MAKEWIDE(x) (x)
4473 #endif
4475 
4484 LIBFLIPRO_API FPRODebug_EnableLevel(bool bEnable, FPRODBGLEVEL eLevel);
4492 LIBFLIPRO_API FPRODebug_SetLogPath(const wchar_t *pPath);
4493 #ifdef WIN32
4504 LIBFLIPRO_VOID _cdecl FPRODebug_Write(FPRODBGLEVEL eLevel, const wchar_t *format, ...);
4505 #else
4516 LIBFLIPRO_VOID FPRODebug_Write(FPRODBGLEVEL eLevel, const wchar_t *format, ...);
4517 #endif
4518 
4519 
4520 
4521 
4522 #endif // _LIBFLIPRO_H_
4523 
4524 #ifdef __cplusplus
4525 }
4526 
4527 #endif
LIBFLIPRO_API FPROFrame_SetFrameReferenceRows(int32_t iHandle, uint32_t uiPreRows, uint32_t uiPostRows)
Sets the reference row count to be added to frame data.
LIBFLIPRO_API FPROFrame_ComputeFrameSizePixels(int32_t iHandle, uint32_t *pTotalWidth, uint32_t *pTotalHeight)
Computes the size in pixels of the image frame.
LIBFLIPRO_API FPROCtrl_SetTemperatureSetPoint(int32_t iHandle, double dblSetPoint)
Sets the Base Temperature Set Point.
LIBFLIPRO_API FPROFrame_GetTestImageEnable(int32_t iHandle, bool *pEnable, FPROTESTIMAGETYPE *pFormat)
Retrieves the test image data settings.
LIBFLIPRO_API FPROCam_GetAPIVersion(wchar_t *pVersion, uint32_t uiLength)
Returns the version of this API Library.
LIBFLIPRO_API FPRODebug_EnableLevel(bool bEnable, FPRODBGLEVEL eLevel)
LIBFLIPRO_API FPROFAck_FrameAcknowledge(int32_t iHandle)
Acknowledge the last frame sent in Frame Acknowledgment Mode.
LIBFLIPRO_API FPROSensor_SetBinning(int32_t iHandle, uint32_t uiXBin, uint32_t uiYBin)
Sets the desired horizontal and vertical binning.
LIBFLIPRO_API FPROFrame_SetTestImageEnable(int32_t iHandle, bool bEnable, FPROTESTIMAGETYPE eFormat)
Enables test image data to be generated rather than normal image data.
unsigned int FPRODBGLEVEL
Convenience (unsigned int) typedef for debug levels.
Definition: libflipro.h:563
struct fpro_stream_stats_t FPROSTREAMSTATS
Streamer Statistics.
LIBFLIPRO_API FPROSensor_GetBinning(int32_t iHandle, uint32_t *pXBin, uint32_t *pYBin)
Retrieves the current pixel bin settings.
LIBFLIPRO_API FPROFrame_MetaValueInitBin(uint8_t *pMetaData, uint32_t uiLength)
Parses the meta data from the given image data for access by the FPROFrame_MetaValueGet() and FPROFra...
FPROUSBSPEED
Known USB Connection Speeds.
Definition: libflipro.h:232
@ FPRO_USB_FULLSPEED
Full Speed Connection.
Definition: libflipro.h:233
@ FPRO_USB_HIGHSPEED
High Speed Connection.
Definition: libflipro.h:234
@ FPRO_USB_SUPERSPEED
Super Speed Connection.
Definition: libflipro.h:235
LIBFLIPRO_API FPROAlgo_SetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE mergeEnables)
Enable/disable hardware merging options.
LIBFLIPRO_API FPROSensor_SetAnalogGain(int32_t iHandle, int32_t iGainValue)
Sets the analog gain for the sensor.
LIBFLIPRO_API FPROFAck_FrameResend(int32_t iHandle)
Re-send the last frame in Frame Acknowledgment Mode.
LIBFLIPRO_API FPROFrame_StreamGetPreviewImageEx(int32_t iHandle, uint8_t *pImage, uint32_t *pLength, FPROPREVIEW *pInfo, uint32_t uiTimeoutMSecs)
Retrieve the next image available for preview from the image stream.
LIBFLIPRO_API FPROFrame_MetaDataToStringBin(uint8_t *pImageData, uint32_t uiImageSizeBytes, wchar_t *pMetaString, uint32_t uiMaxChars)
Convert the meta data in the given file to string.
LIBFLIPRO_API FPROFAck_GetEnable(int32_t iHandle, bool *pEnable)
Get Frame Acknowledgment Mode Enable.
LIBFLIPRO_API FPROFrame_StreamDeinitialize(int32_t iHandle)
Deinitializes the Streamer interfaces.
FPROAUXIO_STATE
Auxiliary Output State.
Definition: libflipro.h:1068
@ FPRO_AUXIO_STATE_LOW
Pin is in the low state.
Definition: libflipro.h:1069
@ FPRO_AUXIO_STATE_HIGH
Pin is in the high state.
Definition: libflipro.h:1070
LIBFLIPRO_API FPROSensor_SetBlackSunAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue)
Sets the current Black Sun Adjustment value.
LIBFLIPRO_API FPROAlgo_StackNextFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS)
Capture and retrieve the next frame to stack from the camera.
struct unpacked_images_t FPROUNPACKEDIMAGES
Unpacked Image Buffers.
LIBFLIPRO_API FPROAlgo_StackDeinitialize(int32_t iHandle)
Returns all the resources allocated during the stacking process to the system.
LIBFLIPRO_API FPROFrame_MetaValueGet(FPRO_META_KEYS eMetaKey, FPROMETAVALUE *pMetaValue)
Retrieve the value for the given meta key.
LIBFLIPRO_API FPROCtrl_GetTemperatures(int32_t iHandle, double *pOtherTemp, double *pBaseTemp, double *pCoolerTemp)
Reads the various temperatures sensors of the camera.
LIBFLIPRO_API FPROCtrl_GetLEDDuration(int32_t iHandle, uint32_t *pDurationUsec)
Get the LED Duration setting.
LIBFLIPRO_API FPROCtrl_SetElectricallyBlackPixelEnable(int32_t iHandle, bool bEnable)
Returns the current Electrically Black Pixel Enable state from the camera.
struct hw_merge_enables_t FPRO_HWMERGEENABLE
Enables for Hardware Image Merging.
LIBFLIPRO_API FPROCtrl_GetBurstModeEnable(int32_t iHandle, bool *pEnable)
Get Camera Burst Mode enable.
LIBFLIPRO_API FPROSensor_SetBlackLevelAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue)
Sets the current Black Level Adjustment values.
struct pixel_info_t FPROPIXELINFO
Defines a location and value of a pixel within an image plane.
LIBFLIPRO_API FPROSensor_GetCapabilityList(int32_t iHandle, uint32_t *pCapList, uint32_t *pNumCaps)
Retrieves the capabilities list for the connected camera.
LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFiles(int32_t iHandle, const wchar_t *pDSNUFile, const wchar_t *pPRNUFile)
Sets the reference frames used in PCIE Fibre hardware image merging.
LIBFLIPRO_API FPROSensor_GetBlackLevelAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue)
Retrieves the current Black Level Adjustment values for the given channel.
FPRODEVICETYPE
Known Device Types.
Definition: libflipro.h:137
@ FPRO_CAM_DEVICE_TYPE_SONYIMX183
Enum value = 0x04000183.
Definition: libflipro.h:145
@ FPRO_CAM_DEVICE_TYPE_FTM
Enum value = 0x04000F1F.
Definition: libflipro.h:146
@ FPRO_CAM_DEVICE_TYPE_GSENSE4040
Enum value = 0x01004040.
Definition: libflipro.h:140
@ FPRO_CAM_DEVICE_TYPE_GSENSE6060
Enum value = 0x01006060.
Definition: libflipro.h:141
@ FPRO_CAM_DEVICE_TYPE_GSENSE400
Enum value = 0x01000400.
Definition: libflipro.h:138
@ FPRO_CAM_DEVICE_TYPE_DC230_84
Enum value = 0x03023084.
Definition: libflipro.h:143
@ FPRO_CAM_DEVICE_TYPE_GSENSE2020
Enum value = 0x01002020.
Definition: libflipro.h:139
@ FPRO_CAM_DEVICE_TYPE_DC230_42
Enum value = 0x03023042.
Definition: libflipro.h:142
@ FPRO_CAM_DEVICE_TYPE_LSGEN
Enum value = 0x850F0000.
Definition: libflipro.h:154
FPROSENSREADCFG
Sensor Read Out Configuration.
Definition: libflipro.h:679
@ FPRO_SENSREAD_CB_BOTTOMLEFT
Read data using the bottom left channel of the sensor.
Definition: libflipro.h:680
@ FPRO_SENSREAD_CB_BOTTOMRIGHT
Read data using the bottom left channel of the sensor.
Definition: libflipro.h:681
@ FPRO_SENSREAD_CB_TOPLEFT
Read data using the top left channel of the sensor.
Definition: libflipro.h:682
@ FPRO_SENSREAD_CB_ALL
Read data using all 4 sensor channels.
Definition: libflipro.h:684
@ FPRO_SENSREAD_CB_TOPRIGHT
Read data using the top right channel of the sensor.
Definition: libflipro.h:683
FPRO_PIXEL_FORMAT
SUpported Pixel Formats across the various cameras.
Definition: libflipro.h:1463
@ PFORMAT_RGBA
Color, 32 bits per pixel with alpha channel (RGBA).
Definition: libflipro.h:1501
@ PFORMAT_MONO12_PACKED
Gray scale 12 bits per pixel so 2 pixels are spread over 3 bytes. The first byte will contain the 8...
Definition: libflipro.h:1477
@ PFORMAT_BAYER12_GBRG_PACKED
12 bits per pixel. Data in Bayer pattern format with first pixel being green (on a blue line)....
Definition: libflipro.h:1480
@ PFORMAT_MONO12_PACKED_MSFIRST
Gray scale 12 bits per pixel so 2 pixels are spread over 3 bytes.
Definition: libflipro.h:1482
@ PFORMAT_HSV4_12
48 bits per pixel; 12 bits for each of degree and angle of polarization, and 12 bits pixel value repe...
Definition: libflipro.h:1511
@ PFORMAT_BAYER8_BGGR
8 bits per pixel. Data in Bayer pattern format with first pixel being bllue.
Definition: libflipro.h:1468
@ PFORMAT_BAYER12_GRBG_PACKED_MSFIRST
12 bits per pixel. Data in Bayer pattern format with first pixel being green (on a red line).
Definition: libflipro.h:1483
@ PFORMAT_BAYER10_BGGR_PACKED_MSFIRST
10 bits per pixel. Data in Bayer pattern format with first pixel being blue.
Definition: libflipro.h:1474
@ PFORMAT_BAYER12_BGGR_PACKED
12 bits per pixel. Data in Bayer pattern format with first pixel being blue. See PFORMAT_MONO12_PACKE...
Definition: libflipro.h:1481
@ PFORMAT_STOKES4_12
48 bits per pixel, 12 bits for each of 4 Stokes channels.
Definition: libflipro.h:1508
@ PFORMAT_ABGR
Color, 32 bits per pixel with alpha channel (ABGR).
Definition: libflipro.h:1504
@ PFORMAT_BAYER16_GBRG
16 bits per pixel. Data in Bayer pattern format with first pixel being green (on a blue line).
Definition: libflipro.h:1494
@ PFORMAT_RGB48
Color, 48 bits per pixel.
Definition: libflipro.h:1506
@ PFORMAT_YUV422
Color, 16 bits per pixel, with a coding pattern of U0, Y0, V0, Y1, U2, Y2, V2, Y3.
Definition: libflipro.h:1491
@ PFORMAT_BAYER12_RGGB_PACKED_MSFIRST
12 bits per pixel. Data in Bayer pattern format with first pixel being red.
Definition: libflipro.h:1484
@ PFORMAT_BGR24
Color, 8 bits per color, 24 bits per pixel (BGR).
Definition: libflipro.h:1499
@ PFORMAT_BAYER16_GRBG
16 bits per pixel. Data in Bayer pattern format with first pixel being green (on a red line).
Definition: libflipro.h:1492
@ PFORMAT_RGB24
Color, 8 bits per color, 24 bits per pixel (RGB).
Definition: libflipro.h:1497
@ PFORMAT_RGB48_DIB
Color, 48 bits per pixel.
Definition: libflipro.h:1507
@ PFORMAT_MONO10_PACKED_MSFIRST
Gray scale 10 bits per pixel. Most significant bit is first (beg-endian like).
Definition: libflipro.h:1470
@ PFORMAT_BAYER12_GRBG_PACKED
12 bits per pixel. Data in Bayer pattern format with first pixel being green (on a red line)....
Definition: libflipro.h:1478
@ PFORMAT_BAYER12_GBRG_PACKED_MSFIRST
12 bits per pixel. Data in Bayer pattern format with first pixel being green (on a blue line).
Definition: libflipro.h:1485
@ PFORMAT_ARGB
Color, 32 bits per pixel with alpha channel (ARGB).
Definition: libflipro.h:1503
@ PFORMAT_BAYER8_RGGB
8 bits per pixel. Data in Bayer pattern format with first pixel being red.
Definition: libflipro.h:1466
@ PFORMAT_BAYER16_RGGB
16 bits per pixel. Data in Bayer pattern format with first pixel being red.
Definition: libflipro.h:1493
@ PFORMAT_BAYER10_RGGB_PACKED_MSFIRST
10 bits per pixel. Data in Bayer pattern format with first pixel being red.
Definition: libflipro.h:1472
@ PFORMAT_MONO16
Gray scale 16 bits per pixel.
Definition: libflipro.h:1489
@ PFORMAT_BAYER8_GBRG
8 bits per pixel. Data in Bayer pattern format with first pixel being green (on a blue line).
Definition: libflipro.h:1467
@ PFORMAT_MONO8
Gray scale 8 bits per pixel.
Definition: libflipro.h:1464
@ PFORMAT_BAYER12_RGGB_PACKED
12 bits per pixel. Data in Bayer pattern format with first pixel being red. See PFORMAT_MONO12_PACKED...
Definition: libflipro.h:1479
@ PFORMAT_BAYER12_BGGR_PACKED_MSFIRST
12 bits per pixel. Data in Bayer pattern format with first pixel being blue.
Definition: libflipro.h:1486
@ PFORMAT_POLAR_RAW4_12
48 bits per pixel; 4 12-bit values for each of the polar channels � 0, 45, 90, and 135 degrees.
Definition: libflipro.h:1510
@ PFORMAT_MONO16_MSFIRST
Gray scale 16 bits per pixel.
Definition: libflipro.h:1490
@ PFORMAT_BAYER10_GBRG_PACKED_MSFIRST
10 bits per pixel. Data in Bayer pattern format with first pixel being green (on a blue line).
Definition: libflipro.h:1473
@ PFORMAT_RGB24_NON_DIB
Color, 24 bits per pixel.
Definition: libflipro.h:1498
@ PFORMAT_BAYER8_GRBG
8 bits per pixel. Data in Bayer pattern format with first pixel being green (on a red line).
Definition: libflipro.h:1465
@ PFORMAT_BAYER10_GRBG_PACKED_MSFIRST
10 bits per pixel. Data in Bayer pattern format with first pixel being green (on a red line).
Definition: libflipro.h:1471
@ PFORMAT_BAYER16_BGGR
16 bits per pixel. Data in Bayer pattern format with first pixel being blue.
Definition: libflipro.h:1495
@ PFORMAT_POLAR4_12
48 bits per pixel � made up of a 12 bit weighted polar channel value, repeated 4 times.
Definition: libflipro.h:1509
@ PFORMAT_BGRA
Color, 32 bits per pixel with alpha channel (BGRA).
Definition: libflipro.h:1502
FPROTESTIMAGETYPE
Test Image Types.
Definition: libflipro.h:443
@ FLI_TESTIMAGE_IMX183_ALL_LOW
IMX183 Sensor All Low Test Pattern. All pixels are 0x000.
Definition: libflipro.h:448
@ FLI_TESTIMAGE_IMX183_ALL_HIGH
IMX183 Sensor All High Test Pattern. All pixels are 0xFFF.
Definition: libflipro.h:449
@ FLI_TESTIMAGE_TYPE_COL
Column order format. The first pixel of the first row will be 0, the second pixel will be 1....
Definition: libflipro.h:445
@ FLI_TESTIMAGE_TYPE_ROW
Row order format. The first 'width' number of pixels will be 0, the second 'width' number of pixels ...
Definition: libflipro.h:444
@ FLI_TESTIMAGE_IMX183_VERTICAL
IMX183 Sensor Vertical Test Pattern.
Definition: libflipro.h:446
@ FLI_TESTIMAGE_IMX183_HORIZONTAL
IMX183 Sensor Horizontal Test Pattern.
Definition: libflipro.h:447
@ FLI_TESTIMAGE_IMX183_LOW_HIGH
IMX183 Sensor Repeating Low High Test Pattern. All pixels are 0x555.
Definition: libflipro.h:450
@ FLI_TESTIMAGE_IMX183_HIGH_LOW
IMX183 Sensor Repeating High Low Test Pattern. All pixels are 0xAAA.
Definition: libflipro.h:451
FPROCAPROI
Region of Interest Support.
Definition: libflipro.h:914
@ FPROCAP_ROI_BYCOL
By Column ROI is supported by the camera.
Definition: libflipro.h:918
@ FPROCAP_ROI_NONE
No ROI supported.
Definition: libflipro.h:915
@ FPROCAP_ROI_BYCOL_API_ONLY
By Column ROI is supported only by the API.
Definition: libflipro.h:919
@ FPROCAP_ROI_BYROW
By Row ROI is supported by the camera.
Definition: libflipro.h:916
@ FPROCAP_ROI_BYROW_API_ONLY
By Row ROI is supported only by the API.
Definition: libflipro.h:917
LIBFLIPRO_API FPROFAck_FlushImageQueue(int32_t iHandle)
Flush the in memory frame queue in Frame Acknowledgment Mode.
struct device_version_info_t FPRODEVICEVERS
Device Version Information.
#define FPRO_USB_STRING_MAXLEN
Maximum String Length.
Definition: libflipro.h:167
LIBFLIPRO_API FPROSensor_SetSamplesPerPixel(int32_t iHandle, FPROCMS eSamplesPerPixel)
Sets the Samples Per Pixel settings on the sensor. NOTE: This function is not supported on on all ...
LIBFLIPRO_API FPROFrame_SetTrackingAreaEnable(int32_t iHandle, uint32_t uiNumTrackingFrames)
Enables the production of Tracking Frames by the camera.
struct conv_info_t FPRO_CONV
Conversion info structure supplied to conversion functions.
LIBFLIPRO_API FPROCam_GetDeviceInfo(int32_t iHandle, FPRODEVICEINFO *pDeviceInfo)
FPROCam_GetDeviceInfo.
LIBFLIPRO_API FPROCam_Open(FPRODEVICEINFO *pDevInfo, int32_t *pHandle)
Connects to the camera specified by the pDevInfo parameter.
LIBFLIPRO_API FPROCam_Close(int32_t iHandle)
Disconnects from the camera an releases the handle.
LIBFLIPRO_API FPROAlgo_GetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE *pMergeEnables)
Retrieve the hardware merge enable settings.
LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFrames(int32_t iHandle, FPRO_REFFRAMES *pRefFrames)
Sets the reference frames used in PCIE Fibre hardware image merging.
FPRO_IMAGE_FORMAT
Output Frame Formats for image merging and conversion.
Definition: libflipro.h:1349
@ IFORMAT_RCD
FLI native RCD Frame.
Definition: libflipro.h:1351
@ IFORMAT_TIFF
TIFF Formatted image.
Definition: libflipro.h:1352
@ IFORMAT_FITS
FITS formatted image.
Definition: libflipro.h:1353
LIBFLIPRO_API FPROFrame_GetFrameType(int32_t iHandle, FPRO_FRAME_TYPE *pType)
Retrieves the Frame Type setting.
FPROAUXIO_EXPACTIVETYPE
Exposure Active Auxiliary Output.
Definition: libflipro.h:1098
@ FPRO_AUXIO_EXPTYPE_EXPOSURE_ACTIVE
Exposure Active- If supported, consult your camera documentation for timing details.
Definition: libflipro.h:1099
@ FPRO_AUXIO_EXPTYPE_FIRST_ROW_SYNC
First Row Sync- If supported, consult your camera documentation for timing details.
Definition: libflipro.h:1101
@ FPRO_AUXIO_EXPTYPE_GLOBAL_EXPOSURE_ACTIVE
Global Exposure Active- If supported, consult your camera documentation for timing details.
Definition: libflipro.h:1100
FPROGPSSTATE
GPS Connection State.
Definition: libflipro.h:610
@ FPRO_GPS_NOT_DETECTED
GPS unit has not been detected by the camera.
Definition: libflipro.h:611
@ FPRO_GPS_DETECTED_SAT_LOCK_TIME_ERROR
GPS unit has been detected by the camera and the satellite lock has been made. The camera has lost th...
Definition: libflipro.h:614
@ FPRO_GPS_DETECTED_AND_SAT_LOCK
GPS unit has been detected by the camera and the satellite lock has been made. This is the only value...
Definition: libflipro.h:613
@ FPRO_GPS_DETECTED_NO_SAT_LOCK
GPS unit has been detected by the camera but the satellite lock has not been made.
Definition: libflipro.h:612
struct device_info_t FPRODEVICEINFO
Device Information.
struct image_plane_stats_t FPROPLANESTATS
Defines the set of statistics available for unpacked frames.
FPROAUXIO
Auxiliary I/O Pins.
Definition: libflipro.h:1012
@ FPRO_AUXIO_2
Name for AUX I/O Pin 2.
Definition: libflipro.h:1014
@ FPRO_AUXIO_1
Name for AUX I/O Pin 1.
Definition: libflipro.h:1013
@ FPRO_AUXIO_3
Name for AUX I/O Pin 3.
Definition: libflipro.h:1015
@ FPRO_AUXIO_4
Name for AUX I/O Pin 4.
Definition: libflipro.h:1016
LIBFLIPRO_API FPROCtrl_SetExposureEx(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate, uint64_t *pActualExposureTime, uint64_t *pActualFrameDelay)
Sets the exposure time of the image sensor.
LIBFLIPRO_API FPROFrame_GetSupportedPixelFormats(int32_t iHandle, FPRO_PIXEL_FORMAT *pFormats, uint32_t *pNumFormats)
Retrieves the supported pixel formats.
FPROGPSOPT
GPS Options.
Definition: libflipro.h:641
@ FPRO_GPSOPT_GLONASS_ENABLE
Enable GLONASS (Globalnaya Navigazionnaya Sputnikovaya Sistema, or Global Navigation Satellite System...
Definition: libflipro.h:643
@ FPRO_GPSOPT_WAAS_EGNOS_ENABLE
Enable the WAAS and EGNOS augmentation feature.
Definition: libflipro.h:642
LIBFLIPRO_API FPROAlgo_StackFinish(int32_t iHandle, uint16_t **ppLowMeanFrame, uint16_t **ppHighMeanFrame, uint32_t *pNumPixels, uint8_t **ppMetaData, uint32_t *puiMetaSize)
Finish the stacking process and retrieve the mean frames.
LIBFLIPRO_API FPROFrame_StreamInitialize(int32_t iHandle, uint32_t uiFrameSizeBytes, wchar_t *pRootPath, wchar_t *pFilePrefix)
Initializes the Streamer interfaces.
#define FPRO_VERSION_STRING_MAXLEN
Version String Lengths.
Definition: libflipro.h:377
LIBFLIPRO_API FPROFrame_StreamStart(int32_t iHandle, uint32_t uiFrameCount, uint64_t uiFrameIntervalMS)
Start the streaming operation.
LIBFLIPRO_API FPROAuxIO_GetExposureActiveType(int32_t iHandle, FPROAUXIO ePin, FPROAUXIO_EXPACTIVETYPE *pType, bool *pActiveHigh)
Get Exposure Active Type Signal.
LIBFLIPRO_API FPROAuxIO_GetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR *pDirection, FPROAUXIO_STATE *pState)
Gets the direction and state for given Auxiliary I/O pin.
LIBFLIPRO_API FPROCtrl_GetHeaterPower(int32_t iHandle, uint32_t *pPwrPercentage)
Reads the current heater configuration.
FPROCAPS
Camera Capabilities.
Definition: libflipro.h:857
@ FPROCAP_NUM
Number of supported capabilities.
Definition: libflipro.h:877
@ FPROCAP_BLACK_SUN_MAX
Max Value Allowed (see FPROSensor_SetBlackSunAdjust())
Definition: libflipro.h:865
@ FPROCAP_BINNING_TABLE_SIZE
0= 1:1 binning only
Definition: libflipro.h:863
@ FPROCAP_PIXEL_BIT_DEPTHS
Bit 'b' is set if pixel b+1 depth allowed (bit 0 (lsb)= pixel depth 1)
Definition: libflipro.h:862
@ FPROCAP_LOW_GAIN_TABLE_SIZE
Number of Gain Values (Low Gain channel for low gain frame in HDR Modes)
Definition: libflipro.h:866
@ FPROCAP_META_DATA_SIZE
Number of bytes used for the pre-frame image meta data.
Definition: libflipro.h:859
@ FPROCAP_MAX_PIXEL_WIDTH
Max allowed image width in pixels.
Definition: libflipro.h:860
@ FPROCAP_ROW_REFERENCE_PIXELS
Number of Pre and Post Row Dummy Pixels when enabled.
Definition: libflipro.h:869
@ FPROCAP_FRAME_REFERENCE_ROWS
Number of Pre and Post Frame Reference rows available.
Definition: libflipro.h:870
@ FPROCAP_ROI_SUPPORT
Definition: libflipro.h:874
@ FPROCAP_DEVICE_TYPE
General device type- see documentation.
Definition: libflipro.h:858
@ FPROCAP_ROW_SCAN_TIME
Row Scan Time in nano secs (LDR)
Definition: libflipro.h:868
@ FPROCAP_MERGE_REFERENCE_FRAMES_SUPPORTED
Whether merge reference frames are supported: 0= not supported, otherwise supported.
Definition: libflipro.h:873
@ FPROCAP_MAX_PIXEL_HEIGHT
Max allowed image height in pixels.
Definition: libflipro.h:861
@ FPROCAP_BLACK_LEVEL_MAX
Max Value Allowed (see FPROSensor_SetBlackLevelAdjust())
Definition: libflipro.h:864
@ FPROCAP_IMAGE_INVERTABLE
False= Normal scan direction only, True= Inverse Scan Available.
Definition: libflipro.h:871
@ FPROCAP_HIGH_GAIN_TABLE_SIZE
Number Of Gain Values (High Gain channel for LDR and HDR Modes)
Definition: libflipro.h:867
@ FPROCAP_NV_STORAGE_AVAILABLE
Number of bytes used for the pre-frame image meta data.
Definition: libflipro.h:872
LIBFLIPRO_API FPROFrame_CaptureStop(int32_t iHandle)
Stops the active image capture.
LIBFLIPRO_API FPROSensor_GetTrainingEnable(int32_t iHandle, bool *pEnable)
Returns the sensor re-training setting.
struct int_point_t FPROPOINT
Point Coordinates.
LIBFLIPRO_API FPROSensor_GetMode(int32_t iHandle, uint32_t uiModeIndex, FPROSENSMODE *pMode)
Retrieves the current mode name for the specified index.
LIBFLIPRO_API FPROFrame_StreamStop(int32_t iHandle)
Stop the streaming operation.
struct ref_frames_t FPRO_REFFRAMES
Reference Frames for Hardware Image Merging.
LIBFLIPRO_API FPROCtrl_GetIlluminationDelay(int32_t iHandle, uint32_t *pOnDelay, uint32_t *pOffDelay)
Gets the delay between setting the Illumination on/off via FPROCtrl_SetIlluminationOn() and when the ...
FPROGAINTABLE
Gain Tables.
Definition: libflipro.h:751
@ FPRO_GAIN_TABLE_HIGH_CHANNEL
High Gain Channel used for LDR modes NOTE: Different cameras support different gain settings....
Definition: libflipro.h:753
@ FPRO_GAIN_TABLE_LOW_CHANNEL
Low Gain Channel used for Low Gain images in HDR modes.
Definition: libflipro.h:752
LIBFLIPRO_API FPROAlgo_SetHardwareMergeThresholds(int32_t iHandle, uint16_t uiHighGainThreshold, uint16_t uiMergeDifferenceThreshold)
Retrieve the current Hardware Merge Threshold values.
struct unpacked_stats_t FPROUNPACKEDSTATS
Statistics for unpacked image planes.
LIBFLIPRO_API FPROCtrl_SetShutterOpen(int32_t iHandle, bool bOpen)
Opens/Close the shutter.
LIBFLIPRO_API FPROCtrl_GetShutterOpen(int32_t iHandle, bool *pOpen)
Gets the current shutter setting.
LIBFLIPRO_API FPROFrame_GetThumbnailFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize)
Retrieves the thumbnail image from the camera.
LIBFLIPRO_API FPROSensor_GetSamplesPerPixel(int32_t iHandle, FPROCMS *pSamplesPerPixel)
Retrieves the Samples Per Pixel settings on the sensor. NOTE: This function is not supported on on...
LIBFLIPRO_API FPROAuxIO_SetExposureActiveType(int32_t iHandle, FPROAUXIO ePin, FPROAUXIO_EXPACTIVETYPE eType, bool bActiveHigh)
Exposure Active Type Signal.
FPROEXTTRIGTYPE
External Trigger Types.
Definition: libflipro.h:496
@ FLI_EXT_TRIGGER_RISING_EDGE
Trigger Exposure on Rising Edge For this setting, when the external trigger line goes from low to hi...
Definition: libflipro.h:498
@ FLI_EXT_TRIGGER_EXPOSE_ACTIVE_HIGH
Exposure Active High For this setting, the exposure is active the entire time the external trigger s...
Definition: libflipro.h:500
@ FLI_EXT_TRIGGER_EXPOSE_ACTIVE_LOW
Exposure Active High For this setting, the exposure is active the entire time the external trigger s...
Definition: libflipro.h:499
@ FLI_EXT_TRIGGER_FALLING_EDGE
Trigger Exposure on Falling Edge For this setting, when the external trigger line goes from high to ...
Definition: libflipro.h:497
LIBFLIPRO_API FPROCam_GetDeviceVersion(int32_t iHandle, FPRODEVICEVERS *pVersion)
Returns the version information from the connected device.
LIBFLIPRO_API FPROSensor_GetScanDirection(int32_t iHandle, bool *pHInverted, bool *pVInverted)
Retrieves the current pixel scan direction settings on the sensor.
LIBFLIPRO_API FPROCtrl_SetFanEnable(int32_t iHandle, bool bOn)
Turns the Fan on or off.
LIBFLIPRO_API FPROCtrl_GetShutterOverride(int32_t iHandle, bool *pOverride)
Gets the current shutter override setting.
LIBFLIPRO_API FPROSensor_SetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG eReadCfg)
Sets the sensor read out configuration on supported models.
FPROAUXIO_DIR
Auxiliary I/O Pin Direction.
Definition: libflipro.h:1041
@ FPRO_AUXIO_DIR_IN
Set AUX I/O pin as an input with respect to the camera.
Definition: libflipro.h:1042
@ FPRO_AUXIO_DIR_OUT
Set AUX I/O pin as an output with respect to the camera.
Definition: libflipro.h:1043
LIBFLIPRO_API FPROCtrl_GetCameraBufferBypass(int32_t iHandle, bool *pCameraBypassEnable, bool *pHostBypassEnable)
Returns the current Camera Buffer Bypass state of the camera.
LIBFLIPRO_API FPROFrame_CaptureThumbnail(int32_t iHandle)
Initiates the capture of a thumbnail image.
LIBFLIPRO_API FPROCtrl_GetExposure(int32_t iHandle, uint64_t *pExposureTime, uint64_t *pFrameDelay, bool *pImmediate)
Reads the exposure time of the image sensor.
LIBFLIPRO_API FPROSensor_SetMode(int32_t iHandle, uint32_t uiModeIndex)
Sets the current mode specified by the given index.
LIBFLIPRO_API FPROSensor_SetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t uiGainIndex)
Sets the current setting for the Gain for the specified table.
LIBFLIPRO_API FPROCtrl_SetHeaterPower(int32_t iHandle, uint32_t uiPwrPercentage)
Turns the Heater on or off at the specified power level.
LIBFLIPRO_API FPROFrame_GetPixelFormat(int32_t iHandle, FPRO_PIXEL_FORMAT *pFormat, uint32_t *pPixelLSB)
Retrieves the current pixel format configuration.
LIBFLIPRO_API FPROFrame_SetTrackingArea(int32_t iHandle, uint32_t uiStartRow, uint32_t uiEndRow)
Sets the area of the image sensor to be used for Tracking Frames during image capture.
#define FPRO_DEVICE_MAX_PATH_LENGTH
Maximum path length for low level OS device path.
Definition: libflipro.h:175
LIBFLIPRO_API FPROCtrl_GetGPSState(int32_t iHandle, FPROGPSSTATE *pState, uint32_t *pOptions)
Returns the current state of an optionally attached GPS unit.
LIBFLIPRO_API FPROSensor_SetTrainingEnable(int32_t iHandle, bool bEnable)
Enables/Disables sensor re-training.
LIBFLIPRO_API FPROFrame_GetVideoFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS)
Retrieves an image frame from the camera.
LIBFLIPRO_API FPROFrame_GetImageArea(int32_t iHandle, uint32_t *pColOffset, uint32_t *pRowOffset, uint32_t *pWidth, uint32_t *pHeight)
Gets the area of the image sensor being used to produce image frame data.
struct con_info_t FPROCONINFO
Connection Information.
LIBFLIPRO_API FPROFrame_SetImageDataEnable(int32_t iHandle, bool bEnable)
Enables image data imaging.
LIBFLIPRO_API FPROFrame_GetFrameReferenceRows(int32_t iHandle, uint32_t *pPreRows, uint32_t *pPostRows)
Retrieves the reference row count to be appended to frame data.
LIBFLIPRO_VOID FPROFrame_FreeUnpackedBuffers(FPROUNPACKEDIMAGES *pUPBuffers)
Frees the Unpacked Buffers within the given structure.
LIBFLIPRO_API FPRONV_ReadNVStorage(int32_t iHandle, uint32_t uiOffset, uint8_t *pData, uint32_t uiLength)
Read the non volatile storage area on the camera.
LIBFLIPRO_API FPROCtrl_SetShutterOverride(int32_t iHandle, bool bOverride)
Sets the shutter control override.
LIBFLIPRO_API FPROFrame_GetVideoFrameExt(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize)
Retrieves an externally triggered image frame from the camera.
LIBFLIPRO_API FPROFrame_UnpackFileEx(wchar_t *pFileName, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats, const wchar_t *pDSNUFile, const wchar_t *pPRNUFile)
Unpack and merge the given file.
LIBFLIPRO_API FPROFrame_SetPixelFormat(int32_t iHandle, FPRO_PIXEL_FORMAT pfPixelFormat, uint32_t uiPixelLSB)
Sets the current pixel configuration to the specified values.
LIBFLIPRO_VOID FPROFrame_FreeUnpackedStatistics(FPROUNPACKEDSTATS *pStats)
Frees the Unpacked Statistics Buffers within the given structure.
LIBFLIPRO_API FPROFrame_StreamGetPreviewImage(int32_t iHandle, uint8_t *pImage, uint32_t *pLength, uint32_t uiTimeoutMSecs)
Retrieve the next image available for preview from the image stream.
LIBFLIPRO_API FPROSensor_GetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG *pReadCfg)
Retrieves the current sensor read out configuration on supported models.
LIBFLIPRO_API FPROSensor_SetScanDirection(int32_t iHandle, bool bHInverted, bool bVInverted)
Retrieves the current pixel scan direction settings on the sensor.
LIBFLIPRO_API FPROCam_GetHostInterfaceInfo(FPROHOSTINFO *pHostInfo, uint32_t *pNum)
Returns information pertaining to the installed host Fibre/PCIE cards.
LIBFLIPRO_API FPROFrame_GetDummyPixelEnable(int32_t iHandle, bool *pEnable)
Retrieves the dummy pixel configuration to be appended row data.
LIBFLIPRO_API FPROSensor_SetHDREnable(int32_t iHandle, FPROHDR eHDREnable)
Sets the setting for HDR enable.
LIBFLIPRO_API FPROFrame_GetImageDataEnable(int32_t iHandle, bool *pEnable)
Enables image data imaging.
LIBFLIPRO_VOID FPRODebug_Write(FPRODBGLEVEL eLevel, const wchar_t *format,...)
LIBFLIPRO_API FPROFrame_ComputeFrameSize(int32_t iHandle)
Computes the size in bytes of the image frame.
struct gain_value_t FPROGAINVALUE
Gain Value.
struct fpro_stream_preview_info_t FPROPREVIEW
Streamer Statistics For Preview Images When obtaining a preview image while streaming,...
LIBFLIPRO_API FPROCtrl_SetIlluminationDelay(int32_t iHandle, uint16_t uiOnDelay, uint16_t uiOffDelay)
Sets the illumination delay.
LIBFLIPRO_API FPROSensor_SetHighGainOnlyEnable(int32_t iHandle, bool bHighGainOnly)
Sets the High Gain Only Mode. Note: The High Gain Only Mode is not applicable to all camera model...
LIBFLIPRO_API FPROAlgo_GetHardwareMergeThresholds(int32_t iHandle, uint16_t *pHighGainThreshold, uint16_t *pMergeDifferenceThreshold)
Retrieve the current Hardware Merge Threshold values.
LIBFLIPRO_API FPROSensor_GetHighGainOnlyEnable(int32_t iHandle, bool *pHighGainOnly)
Retrieves the High Gain Only Mode.
#define FPRO_SENSOR_MODE_NAME_LENGTH
Sensor Mode Name Length.
Definition: libflipro.h:696
LIBFLIPRO_API FPROCtrl_SetGPSOptions(int32_t iHandle, uint32_t uiOptions)
Set the tracking options of an optionally attached GPS unit.
struct host_if_info FPROHOSTINFO
Host driver and hardware information.
LIBFLIPRO_API FPROCtrl_SetCameraBufferBypass(int32_t iHandle, bool bCameraBypassEnable, bool bHostBypassEnable)
Set Camera Buffer Bypass state of the camera.
LIBFLIPRO_API FPROFrame_SetDummyPixelEnable(int32_t iHandle, bool bEnable)
Returns whether or not Image Frame data is ready for retrieval.
LIBFLIPRO_API FPROCtrl_SetExternalTriggerEnable(int32_t iHandle, uint32_t uiFrameCount, FPROEXTTRIGINFO *pTrigInfo)
Enables or disables the external trigger of the camera.
struct ext_trigger_info_t FPROEXTTRIGINFO
External Trigger Setup Details.
LIBFLIPRO_API FPROSensor_GetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t *pGainIndex)
Retrieves the current setting for the Gain for the specified table.
LIBFLIPRO_API FPROCtrl_SetIlluminationOn(int32_t iHandle, bool bOn)
Turns External Illumination on or off.
LIBFLIPRO_API FPRONV_WriteNVStorage(int32_t iHandle, uint32_t uiOffset, uint8_t *pData, uint32_t uiLength)
Write the given data to the non volatile storage area on the camera.
FPROBLACKADJUSTCHAN
Black Adjust Channels.
Definition: libflipro.h:800
@ FPRO_BLACK_ADJUST_CHAN_HDR
Specifies the HDR Black adjust channel. NOTE: Not supported on all devices. See your specific device...
Definition: libflipro.h:802
@ FPRO_BLACK_ADJUST_CHAN_LDR
Specifies the LDR Black adjust channel.
Definition: libflipro.h:801
LIBFLIPRO_API FPROCtrl_GetTemperatureSetPoint(int32_t iHandle, double *pSetPoint)
Returns the Base Temperature Set Point.
LIBFLIPRO_API FPROFrame_UnpackFile(wchar_t *pFileName, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats)
Unpack and merge the given file.
LIBFLIPRO_API FPROFrame_MetaValueGetNext(FPROMETAVALUE *pMetaValue)
Retrieve the next meta key value.
#define FPRO_META_VALUE_STRING_LENGTH_MAX
Maximum length of a Meta Data string value See FPROMETAVALUE.
Definition: libflipro.h:1937
LIBFLIPRO_API FPROFAck_SetEnable(int32_t iHandle, bool bEnable)
Set Frame Acknowledgment Mode Enable.
struct meta_data_value_t FPROMETAVALUE
Defined a value for Meta Data fields.
LIBFLIPRO_API FPROCtrl_SetExposure(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate)
Sets the exposure time of the image sensor.
LIBFLIPRO_API FPROSensor_GetBlackSunAdjust(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue)
Retrieves the current Black Sun Adjustment values for the given channel.
FPRO_HWMERGEFRAMES
Enables for Hardware Image Merging.
Definition: libflipro.h:1564
@ HWMERGE_FRAME_HIGHONLY
Only the corrected high gain pixels will be sent through to the API. The low gain pixels will be igno...
Definition: libflipro.h:1567
@ HWMERGE_FRAME_BOTH
Normal merge, both low and high gain planes are corrected and merged.
Definition: libflipro.h:1565
@ HWMERGE_FRAME_LOWONLY
Only the corrected low gain pixels will be sent through to the API. The high gain pixels will be igno...
Definition: libflipro.h:1566
LIBFLIPRO_API FPROFrame_CaptureStart(int32_t iHandle, uint32_t uiFrameCount)
Initiates the capture of the configured image.
LIBFLIPRO_API FPROAuxIO_SetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR eDirection, FPROAUXIO_STATE eState)
Sets the direction and state for given Auxiliary I/O pin.
LIBFLIPRO_API FPROFrame_MetaValueInit(wchar_t *pFileName)
Parses the meta data from the given file for access by the FPROFrame_MetaValueGet() and FPROFrame_Met...
FPROCMS
Correlated Multiple Samples (Samples Per Pixel)
Definition: libflipro.h:1272
@ FPROCMS_2
Two sensor samples per pixel are read out.
Definition: libflipro.h:1274
@ FPROCMS_4
Four sensor samples per pixel are read out.
Definition: libflipro.h:1275
@ FPROCMS_1
Single Sample Per Pixel. This is the default for all cameras.
Definition: libflipro.h:1273
LIBFLIPRO_API FPROFrame_SetImageArea(int32_t iHandle, uint32_t uiColOffset, uint32_t uiRowOffset, uint32_t uiWidth, uint32_t uiHeight)
Sets the area of the image sensor to be used to produce image frame data.
struct ip_info_t FPROIPINFO
IP Connection Information.
FPRO_FRAME_TYPE
Image Frame Type.
Definition: libflipro.h:1240
@ FPRO_FRAMETYPE_LIGHTFLASH
Light Flash Frame.
Definition: libflipro.h:1244
@ FPRO_FRAMETYPE_NORMAL
Normal Frame (default).
Definition: libflipro.h:1241
@ FPRO_FRAMETYPE_DARK
Dark Frame.
Definition: libflipro.h:1242
@ FPRO_FRAMETYPE_DARKFLASH
Dark Flash Frame.
Definition: libflipro.h:1245
@ FPRO_FRAMETYPE_BIAS
Bias Frame.
Definition: libflipro.h:1243
LIBFLIPRO_API FPROFrame_CaptureAbort(int32_t iHandle)
Aborts the active image capture.
LIBFLIPRO_API FPRODebug_SetLogPath(const wchar_t *pPath)
FPROSTREAMERSTATUS
Streamer Status.
Definition: libflipro.h:1140
@ FPRO_STREAMER_STOPPED
Streaming Stopped. This is the default state. It also enters this state when the requested number of ...
Definition: libflipro.h:1142
@ FPRO_STREAMER_STOPPED_ERROR
If streaming has stopped due to an error, the status will be less than 0. Consult the log file for er...
Definition: libflipro.h:1141
@ FPRO_STREAMER_STREAMING
Streaming is running. This state is entered when streaming is started via the FPROFrame_StreamStart()...
Definition: libflipro.h:1143
LIBFLIPRO_API FPROAlgo_StackInitialize(int32_t iHandle)
Initialize the stacking process.
LIBFLIPRO_API FPROCtrl_SetLED(int32_t iHandle, bool bOn)
Turn the LED on or off.
LIBFLIPRO_API FPROCtrl_GetSensorTemperature(int32_t iHandle, int32_t *pTemp)
Reads the internal sensor temperature of the camera.
LIBFLIPRO_API FPROSensor_GetHDREnable(int32_t iHandle, FPROHDR *pHDREnable)
Retrieves the current setting for HDR enable.
LIBFLIPRO_API FPROCtrl_GetElectricallyBlackPixelEnable(int32_t iHandle, bool *pEnable)
Returns the current Electrically Black Pixel Enable state from the camera.
struct sensor_mode_t FPROSENSMODE
Sensor Modes.
LIBFLIPRO_API FPROCtrl_GetFanEnable(int32_t iHandle, bool *pOn)
Returns the current Fan status, on or off.
LIBFLIPRO_API FPROCtrl_GetPCIETemperatures(int32_t iHandle, double *pPcieFpga, double *pFibreFpga)
Returns the temperatures on the Host PCIE Fibre Interface card.
LIBFLIPRO_API FPROFrame_SetFrameType(int32_t iHandle, FPRO_FRAME_TYPE eType)
Sets Frame Type produced by the camera.
LIBFLIPRO_API FPROCtrl_SetBurstModeEnable(int32_t iHandle, bool bEnable)
Set Camera Burst Mode enable.
LIBFLIPRO_API FPROCtrl_SetSensorTemperatureReadEnable(int32_t iHandle, bool bEnable)
Enables/disables physical reading of the image sensor temperature during exposures.
LIBFLIPRO_API FPROCtrl_GetLED(int32_t iHandle, bool *pOn)
Returns the state of the LED on or off setting.
FPRO_META_KEYS
The list of available Meta Data keys.
Definition: libflipro.h:1823
@ META_KEY_CAPTURE_DATE
(uiYear << 16) | (uiMonth << 8) | (uiDay)
Definition: libflipro.h:1837
LIBFLIPRO_API FPROFrame_GetVideoFrameUnpacked(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats)
Retrieves an image frame from the camera and optionally unpacks and merges the image planes.
LIBFLIPRO_API FPROCtrl_GetExternalTriggerEnable(int32_t iHandle, FPROEXTTRIGINFO *pTrigInfo)
Returns the external trigger settings of the camera.
LIBFLIPRO_API FPROCam_GetCameraList(FPRODEVICEINFO *pDeviceInfo, uint32_t *pNumDevices)
FPROCam_GetCameraList.
LIBFLIPRO_API FPROSensor_GetBinningTable(int32_t iHandle, uint32_t *pBinTable, uint32_t *pTableSizeBytes)
Retrieves the Binning table capability from the camera.
LIBFLIPRO_API FPROCtrl_GetSensorTemperatureReadEnable(int32_t iHandle, bool *pEnable)
Returns the 'read sensor temperature during exposure' enabled flag.
LIBFLIPRO_API FPROFrame_MetaDataToString(wchar_t *pFileName, wchar_t *pMetaString, uint32_t uiMaxChars)
Convert the meta data in the given file to string.
LIBFLIPRO_API FPROSensor_GetModeCount(int32_t iHandle, uint32_t *pCount, uint32_t *pCurrentMode)
Retrieves the current mode count and current mode index setting.
LIBFLIPRO_API FPROCtrl_GetCoolerDutyCycle(int32_t iHandle, uint32_t *pDutyCycle)
Reads the current duty cycle of the cooler.
LIBFLIPRO_API FPROCtrl_SetLEDDuration(int32_t iHandle, uint32_t uiDurationUSec)
Set LED Duration during exposure.
LIBFLIPRO_API FPROFrame_GetVideoFrameUnpackedExt(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats)
Retrieves an externally triggered image frame from the camera and unpacks the image.
LIBFLIPRO_API FPROFrame_StreamGetStatistics(int32_t iHandle, FPROSTREAMSTATS *pStats)
Stop the streaming operation.
LIBFLIPRO_API FPROFrame_ConvertFile(wchar_t *pInRcdFile, FPRO_CONV *pConvInfo, wchar_t *pOutFile)
Convert (and possibly) merge the given RCD file.
FPROHDR
HDR Mode setting.
Definition: libflipro.h:977
@ FPRO_HDR_CAMERA
HDR Mode is enabled and the camera will combine the image planes.
Definition: libflipro.h:979
@ FPRO_HDR_DISABLED
HDR mode is disabled.
Definition: libflipro.h:978
@ FPRO_HDR_INTERLEAVED
HDR Mode is enabled and the application must combine the image planes.
Definition: libflipro.h:980
LIBFLIPRO_API FPROSensor_GetGainTable(int32_t iHandle, FPROGAINTABLE eTable, FPROGAINVALUE *pGainValues, uint32_t *pNumEntries)
Retrieves the specified Gain Table.
FPROCONNECTION
Supported Connection Types.
Definition: libflipro.h:198
@ FPRO_CONNECTION_ENET
Camera is connected with an ethernet link.
Definition: libflipro.h:201
@ FPRO_CONNECTION_USB
Camera is connected with a USB link.
Definition: libflipro.h:199
@ FPRO_CONNECTION_FIBRE
Camera is connected with a Fibre Optic link.
Definition: libflipro.h:200
struct fibre_info_t FPROFIBREINFO
Fibre Connection Information.
LIBFLIPRO_API FPROCtrl_GetIlluminationOn(int32_t iHandle, bool *pOn)
Returns the setting of External Illumination- on or off.
Definition: libflipro.h:307
uint32_t uiProdId
The USB Product ID. This field is applicable only when the eConnType is FPRO_CONNECTION_USB.
Definition: libflipro.h:310
uint32_t uiVendorId
The USB vendor ID. This field is applicable only when the eConnType is FPRO_CONNECTION_USB.
Definition: libflipro.h:309
FPROCONNECTION eConnType
The physical connection type. If the connection type is FPRO_CONNECTION_USB, then the uiVendorId,...
Definition: libflipro.h:308
union con_info_t::@0 attr
The attributes of the connection, This eUSBSpeed field is applicable only when the eConnType is FPRO_...
Definition: libflipro.h:1538
FPRO_IMAGE_FORMAT eFormat
File format for the converted frame.
Definition: libflipro.h:1539
wchar_t * pDSNUFile
DSNU Reference file (may be NULL).
Definition: libflipro.h:1540
wchar_t * pPRNUFile
PRNU Reference file (may be NULL).
Definition: libflipro.h:1541
Definition: libflipro.h:365
wchar_t cFriendlyName[FPRO_USB_STRING_MAXLEN]
Human readable friendly name of the USB device. This string along with the cSerialNo field provide a ...
Definition: libflipro.h:366
wchar_t cSerialNo[FPRO_USB_STRING_MAXLEN]
The manufacturing serial number of the device.
Definition: libflipro.h:367
wchar_t cDevicePath[FPRO_DEVICE_MAX_PATH_LENGTH]
The OS device Path. Used internally by the API for opening requisite file descriptors to connect to t...
Definition: libflipro.h:368
FPROCONINFO conInfo
Details of the physical connection.
Definition: libflipro.h:369
Definition: libflipro.h:396
wchar_t cControllerVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the internal sensor controller device.
Definition: libflipro.h:399
wchar_t cFirmwareVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the internal device processor.
Definition: libflipro.h:397
wchar_t cFPGAVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the internal FPGA device.
Definition: libflipro.h:398
wchar_t cHostHardwareVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the host interface card if any. For example, it returns the hardware versi...
Definition: libflipro.h:400
Definition: libflipro.h:527
FPROEXTTRIGTYPE eTriggerType
The trigger behavior type.
Definition: libflipro.h:528
bool bEnable
True= enable the external trigger. False= disable the external trigger.
Definition: libflipro.h:530
bool bSingleFramePerTrigger
Default behavior of the external trigger gets uiFrameCount images. Setting this ensures only a single...
Definition: libflipro.h:529
Definition: libflipro.h:278
uint32_t uiChannelStatus
The Channel status of the card. Used internally by the API.
Definition: libflipro.h:279
uint64_t uiVersion
The version information from the PCIE Fibre card.
Definition: libflipro.h:280
Definition: libflipro.h:1209
FPROSTREAMSTATS streamStats
The stream statistics. See FPROSTREAMSTATS.
Definition: libflipro.h:1211
uint32_t uiFrameNumber
The frame number returned in the preview.
Definition: libflipro.h:1210
Definition: libflipro.h:1184
double dblOverallFramesPerSec
The overall frames per second received by the streamer. Note this depends on actual frame rate from t...
Definition: libflipro.h:1190
double dblDiskAvgMBPerSec
The average disk write rate in MBytes/sec on a per frame basis.
Definition: libflipro.h:1188
uint32_t uiReserved
Reserved for internal use.
Definition: libflipro.h:1193
uint64_t uiTotalBytesReceived
The total number of bytes received from the camera.
Definition: libflipro.h:1186
FPROSTREAMERSTATUS iStatus
The status of the streamer. See FPROSTREAMERSTATUS.
Definition: libflipro.h:1192
uint32_t uiNumFramesReceived
The number of frames received from the camera.
Definition: libflipro.h:1185
double dblDiskPeakMBPerSec
The peak write rate in MBytes/sec; the fastest a given frame was written.
Definition: libflipro.h:1189
double dblOverallMBPerSec
The overall MB per second received by the streamer. Note this depends on actual frame rate from the c...
Definition: libflipro.h:1191
uint64_t uiDiskFramesWritten
The total number of frames written to disk.
Definition: libflipro.h:1187
Definition: libflipro.h:775
uint32_t uiValue
The actual gain value.
Definition: libflipro.h:776
uint32_t uiDeviceIndex
The device index to use to set the gain value on the camera.
Definition: libflipro.h:777
Definition: libflipro.h:337
uint32_t uiDriverVersion
The driver version.
Definition: libflipro.h:338
uint64_t uiHWVersion
The hardware version information if available.
Definition: libflipro.h:339
wchar_t cFibreSerialNum[FPRO_USB_STRING_MAXLEN]
The serial number of the Fibre portion of the PCIE card.
Definition: libflipro.h:340
wchar_t cPcieSerialNum[FPRO_USB_STRING_MAXLEN]
The serial number of the PCIE portion of the PCIE card.
Definition: libflipro.h:341
Definition: libflipro.h:1607
FPRO_IMAGE_FORMAT eMergeFormat
The image file format for the merged image. The Actual PCIE card only supports RCD and TIFF....
Definition: libflipro.h:1609
FPRO_HWMERGEFRAMES eMergeFrames
Specifies the frames to merge.
Definition: libflipro.h:1610
bool bMergeEnable
True if merging enabled. This must be true for the other enables to have any effect....
Definition: libflipro.h:1608
Definition: libflipro.h:1761
uint32_t uiLCutoff
The lower pixel value cutoff.
Definition: libflipro.h:1762
FPROPIXELINFO pixDimmest
The location and value of the dimmest pixel in the plane.
Definition: libflipro.h:1772
double dblMedian
The median of the pixel values in the plane.
Definition: libflipro.h:1767
uint32_t uiUCutoff
The Upper pixel value cutoff.
Definition: libflipro.h:1763
double dblMode
The mode of the pixel values in the plane.
Definition: libflipro.h:1768
FPROPIXELINFO pixBrightest
The location and value of the brightest pixel in the plane.
Definition: libflipro.h:1771
uint32_t uiHistogramSize
The number of elements in the array pointed to by pdblHistogram.
Definition: libflipro.h:1764
double dblMean
The mean of the pixel values in the plane.
Definition: libflipro.h:1766
double * pdblHistogram
The pixel value histogram. The index is the pixel value, the value at that index is the number of pix...
Definition: libflipro.h:1765
double dblStandardDeviation
The standard deviation of the pixels in the plane.
Definition: libflipro.h:1769
Definition: libflipro.h:1711
int32_t X
The x coordinate.
Definition: libflipro.h:1712
int32_t Y
The y coordinate.
Definition: libflipro.h:1713
Definition: libflipro.h:260
uint32_t uiSpeed
If it can be determined on the host, the speed of the connection in Mega-bits per second....
Definition: libflipro.h:262
uint32_t uiIPAddress
The IP Address of the camera. The 32 bit number is partitioned in 8 bit quantities corresponding to t...
Definition: libflipro.h:261
Definition: libflipro.h:1958
uint8_t cStringValue[FPRO_META_VALUE_STRING_LENGTH_MAX]
The character string value is the meta data value is a string.
Definition: libflipro.h:1961
int32_t iByteLength
If the value is a string value, this field is the string length. If set to zero indicates an empty st...
Definition: libflipro.h:1960
double dblValue
The value of a given meta data key if it is a numerical value.
Definition: libflipro.h:1959
Definition: libflipro.h:1729
uint32_t uiValue
The pixel value.
Definition: libflipro.h:1731
FPROPOINT ptPosition
The x and y coordinate of the pixel within the plane.
Definition: libflipro.h:1730
Definition: libflipro.h:1321
uint16_t * pMultiplicativeLowGain
Low Gain Multiply Reference Frame.
Definition: libflipro.h:1327
int16_t * pAdditiveHighGain
High Gain Additive Reference Frame.
Definition: libflipro.h:1326
int16_t * pAdditiveLowGain
Low Gain Additive Reference Frame.
Definition: libflipro.h:1325
uint32_t uiWidth
Width of the frames in pixels.
Definition: libflipro.h:1322
uint32_t uiHeight
Height of the frames in pixels.
Definition: libflipro.h:1323
uint16_t * pMultiplicativeHighGain
High Gain Multiply Reference Frame.
Definition: libflipro.h:1328
Definition: libflipro.h:715
wchar_t wcModeName[FPRO_SENSOR_MODE_NAME_LENGTH]
A descriptive human readable name for the mode suitable for a user interface.
Definition: libflipro.h:717
uint32_t uiModeIndex
The corresponding index of the mode name.
Definition: libflipro.h:716
Definition: libflipro.h:1671
bool bHighImageRequest
The High Image request Flag. Set to 'true' to unpack the high gain image plane.
Definition: libflipro.h:1685
FPRO_IMAGE_FORMAT eMergeFormat
On entry to the FPROFrame_GetVideoFrameUnpacked() API, it is the requested format for the unpacked/me...
Definition: libflipro.h:1693
uint8_t * pMergedMetaData
This meta data reflects the image data in the pMergedImage buffer.
Definition: libflipro.h:1687
bool bMetaDataRequest
The Meta Data request Flag. Set to 'true' to unpack meta data.
Definition: libflipro.h:1673
uint8_t * pLowMetaData
This meta data reflects the image data in the pLowImage buffer.
Definition: libflipro.h:1675
uint16_t * pLowImage
The Low Image Buffer.
Definition: libflipro.h:1676
uint64_t uiMergedBufferSize
The Size of the pMergedImage buffer in bytes. This will be different than uiMergedImageSize * sizeof(...
Definition: libflipro.h:1690
uint64_t uiMergedImageSize
The Size of the pMergedImage image in pixels.
Definition: libflipro.h:1689
uint64_t uiLowImageSize
The Size of the pLowImage image in pixels.
Definition: libflipro.h:1677
bool bMergedImageRequest
The Merged Image request Flag. Set to 'true' to merge the low and high gain image planes.
Definition: libflipro.h:1691
uint64_t uiHighImageSize
The Size of the pHighImage image in pixels.
Definition: libflipro.h:1683
uint64_t uiHighBufferSize
The Size of the pHighImage buffer in bytes. This may be different than uiHighImageSize * sizeof(uint1...
Definition: libflipro.h:1684
uint8_t * pHighMetaData
This meta data reflects the image data in the pHighImage buffer.
Definition: libflipro.h:1681
uint16_t * pHighImage
The High Image Buffer.
Definition: libflipro.h:1682
uint32_t uiMetaDataSize
The Size of the pMetaData buffer in bytes.
Definition: libflipro.h:1672
bool bLowImageRequest
The Low Image request Flag. Set to 'true' to unpack the low gain image plane.
Definition: libflipro.h:1679
uint16_t * pMergedImage
The Merged Image Buffer.
Definition: libflipro.h:1688
uint64_t uiLowBufferSize
The Size of the pLowImage buffer in bytes. This may be different than uiLowImageSize * sizeof(uint16_...
Definition: libflipro.h:1678
Definition: libflipro.h:1797
FPROPLANESTATS statsMergedImage
The statistics for the merged image.
Definition: libflipro.h:1804
FPROPLANESTATS statsLowImage
The statistics for the low image.
Definition: libflipro.h:1798
bool bMergedRequest
Set to true to request the statistics for this image plane when unpacking.
Definition: libflipro.h:1805
bool bLowRequest
Set to true to request the statistics for this image plane when unpacking.
Definition: libflipro.h:1799
FPROPLANESTATS statsHighImage
The statistics for the high image.
Definition: libflipro.h:1801
bool bHighRequest
Set to true to request the statistics for this image plane when unpacking.
Definition: libflipro.h:1802