PUCLIB 1.6.0.0
PHOTRON USB Control Library
PUCCONST.h
Go to the documentation of this file.
1#ifndef __PUCCONST_H
2#define __PUCCONST_H
3
4/*
5 * PUCCONST.h
6 * PHOTRON INFINICAM Control SDK
7 *
8 * Copyright (C) 2023 PHOTRON LIMITED
9 */
10
11#ifdef __cplusplus
12extern "C" {
13#endif
14
17#define PUC_MAX_DEVICE 16
20#define PUC_MAX_LEN 256
23#define PUC_Q_COUNT 64
26#define PUC_MIN_RING_BUF_COUNT 4
29#define PUC_MAX_RING_BUF_COUNT 65535
32#define PUC_XFER_TIMEOUT_AUTO 0
35#define PUC_XFER_TIMEOUT_INFINITE 0xFFFFFFFF
38#define PUC_SYNC_OUT_MAGNIFICATION_0_5 0
41#define PUC_MAX_DECODE_THREAD_COUNT 32
42
43
46typedef enum
47{
53 PUC_ON = 1,
54} PUC_MODE;
55
58typedef enum
59{
67
70typedef enum
71{
79
82typedef enum
83{
91
94typedef void* PUC_HANDLE;
98
101typedef enum
102{
187
191
195
199
203
207
208
209} PUCRESULT;
210
211
212
213
216#define PUC_CHK_SUCCEEDED(res) (res == PUC_SUCCEEDED)
219#define PUC_CHK_FAILED(res) (res != PUC_SUCCEEDED)
220
221#ifdef __cplusplus
222}
223#endif
224
225#endif /* __PUCCONST_H */
void * PUC_HANDLE
Device handle.
Definition: PUCCONST.h:94
PUCRESULT
Error code.
Definition: PUCCONST.h:102
@ PUC_ERROR_NOTEQUAL_READ_SIZE
The data of specified size could not be read from the device.
Definition: PUCCONST.h:156
@ PUC_ERROR_GPU_MEMORY_COPY
Failed to copy GPU memory.
Definition: PUCCONST.h:202
@ PUC_ERROR_RING_BUF_COUNT
The specified ring buffer count is invalid.
Definition: PUCCONST.h:177
@ PUC_ERROR_DEVICE_WRITE
Failed to write data to the device.
Definition: PUCCONST.h:141
@ PUC_ERROR_ILLEGAL_FRAME_RATE
The specified framerate cannot be set.
Definition: PUCCONST.h:126
@ PUC_ERROR_INITIALIZED
Initialization is already complete.
Definition: PUCCONST.h:111
@ PUC_ERROR_XFER_DATA_FINISH
The data transfer ended abnormally.
Definition: PUCCONST.h:171
@ PUC_ERROR_NOTEQUAL_WRITE_SIZE
The data of specified size could not be written to the device.
Definition: PUCCONST.h:159
@ PUC_ERROR_GPU_UNINITIALIZE
The setup required for GPU processing is not done, please run PUC_SetupGPUDecode.
Definition: PUCCONST.h:206
@ PUC_ERROR_FREE_BUFFER
Failed to release the buffer.
Definition: PUCCONST.h:194
@ PUC_ERROR_ILLEGAL_RESOLUTION
The specified resolution cannot be set.
Definition: PUCCONST.h:123
@ PUC_ERROR_GPU_DECODE_PROCESS
GPU decode process failed.
Definition: PUCCONST.h:186
@ PUC_ERROR_XFER_DATA_WAIT
An unexpected error occurred during waiting for a data transfer from the device.
Definition: PUCCONST.h:168
@ PUC_ERROR_MODULE_LOAD
There are modules in the SDK that could not load.
Definition: PUCCONST.h:144
@ PUC_ERROR_ALLOCATE_BUFFUER
Failed to allocate buffer.
Definition: PUCCONST.h:190
@ PUC_ERROR_XFERRING
Unable to process as a data transfer is in progress.
Definition: PUCCONST.h:174
@ PUC_ERROR_DEVICE_NOTOPEN
The device is not open.
Definition: PUCCONST.h:135
@ PUC_ERROR_DEVICE_OPEN
Failed to open the device.
Definition: PUCCONST.h:132
@ PUC_ERROR_GPU_SYNCHRONIZE
Failed to synchronize GPU processing.
Definition: PUCCONST.h:198
@ PUC_ERROR_XFER_DATA_INVALID_HEADER
The header information in the data received from the device is invalid.
Definition: PUCCONST.h:162
@ PUC_ERROR_NOTSUPPORT
This function is not supprted.
Definition: PUCCONST.h:183
@ PUC_ERROR_SET_CMD
Failed to send a SET command to the device.
Definition: PUCCONST.h:153
@ PUC_ERROR_GET_CMD
Failed to send a GET command to the device.
Definition: PUCCONST.h:150
@ PUC_ERROR_ILLEGAL_EXPOSE_CLOCK
The specified exposure time or non-exposure time (clock units) cannot be set.
Definition: PUCCONST.h:129
@ PUC_ERROR_DEVICE_READ
Failed to read data from the device.
Definition: PUCCONST.h:138
@ PUC_ERROR_ILLEGAL_ARG
The specified argument is NULL.
Definition: PUCCONST.h:120
@ PUC_ERROR_ILLEGAL_DEVICE_HANDLE
The specified device handle is NULL.
Definition: PUCCONST.h:117
@ PUC_ERROR_UNINITIALIZE
Initialization has not been performed. Please execute the PUC_Initialize function.
Definition: PUCCONST.h:108
@ PUC_SUCCEEDED
Succeeded.
Definition: PUCCONST.h:105
@ PUC_ERROR_SYNC_EXTERNAL
Unable to process as a synchronize to external signal is in progress.
Definition: PUCCONST.h:180
@ PUC_ERROR_LOCK_TIMEOUT
The exclusive process of the function has timed out.
Definition: PUCCONST.h:147
@ PUC_ERROR_XFER_DATA_BEGIN
Unable to start data transfer.
Definition: PUCCONST.h:165
@ PUC_ERROR_NOT_EXIST_DEVICE_NO
The specified device number does not exist.
Definition: PUCCONST.h:114
PUC_MODE
Enumeration for ON/OFF setting.
Definition: PUCCONST.h:47
@ PUC_ON
ON.
Definition: PUCCONST.h:53
@ PUC_OFF
OFF.
Definition: PUCCONST.h:50
PUC_COLOR_TYPE
Enumeration for device color/monochrome setting.
Definition: PUCCONST.h:83
@ PUC_COLOR_MONO
Monochrome.
Definition: PUCCONST.h:86
@ PUC_COLOR_COLOR
Color.
Definition: PUCCONST.h:89
PUC_SYNC_MODE
Enumeration for synchronization.
Definition: PUCCONST.h:71
@ PUC_SYNC_EXTERNAL
Synchronize to external signal.
Definition: PUCCONST.h:77
@ PUC_SYNC_INTERNAL
Internal operation.
Definition: PUCCONST.h:74
PUC_HANDLE * PPUC_HANDLE
Pointer for the device handle.
Definition: PUCCONST.h:97
PUC_SIGNAL
Enumeration for signal polarity.
Definition: PUCCONST.h:59
@ PUC_SIGNAL_NEGA
Negative polarity signal.
Definition: PUCCONST.h:65
@ PUC_SIGNAL_POSI
Positive polarity signal.
Definition: PUCCONST.h:62