PUCCONST.h File Reference

Go to the source code of this file.

Macros
#define	PUC_MAX_DEVICE   16
	Maximum number of connectable devices.
#define	PUC_MAX_LEN   256
	Maximum number of characters.
#define	PUC_Q_COUNT   64
	Quantization table count (8*8)
#define	PUC_MIN_RING_BUF_COUNT   4
	Minimum ring buffer count for continuous transfer.
#define	PUC_MAX_RING_BUF_COUNT   65535
	Maximum ring buffer count for continuous transfer.
#define	PUC_XFER_TIMEOUT_AUTO   0
	Mode for automatically setting the timeout duration (ms) based on the frame rate when no response is received from the device.
#define	PUC_XFER_TIMEOUT_INFINITE   0xFFFFFFFF
	Mode for setting the timeout duration (ms) to infinite when no response is received from the device.
#define	PUC_SYNC_OUT_MAGNIFICATION_0_5   0
	Constant value expressing the output magnification rate of synchronization signal is 0.5.
#define	PUC_MAX_DECODE_THREAD_COUNT   32
	Constant value expressing the thread count for multi thread decoding.
#define	PUC_CHK_SUCCEEDED(res)
	The macro to be positive when an error code is normal.
#define	PUC_CHK_FAILED(res)
	The macro to be positive when an error code is not normal.

Typedefs
typedef void *	PUC_HANDLE
	Device handle.
typedef PUC_HANDLE *	PPUC_HANDLE
	Pointer for the device handle.

Enumerations
enum	PUC_MODE { PUC_OFF = 0 , PUC_ON = 1 }
	Enumeration for ON/OFF setting. More...
enum	PUC_SIGNAL { PUC_SIGNAL_POSI = 0 , PUC_SIGNAL_NEGA = 1 }
	Enumeration for signal polarity. More...
enum	PUC_SYNC_MODE { PUC_SYNC_INTERNAL = 0 , PUC_SYNC_EXTERNAL = 1 }
	Enumeration for synchronization. More...
enum	PUC_COLOR_TYPE { PUC_COLOR_MONO = 0 , PUC_COLOR_COLOR = 1 }
	Enumeration for device color/monochrome setting. More...
enum	PUCRESULT {   PUC_SUCCEEDED = 0 , PUC_ERROR_UNINITIALIZE = 1 , PUC_ERROR_INITIALIZED = 2 , PUC_ERROR_NOT_EXIST_DEVICE_NO = 3 ,   PUC_ERROR_ILLEGAL_DEVICE_HANDLE = 4 , PUC_ERROR_ILLEGAL_ARG = 5 , PUC_ERROR_ILLEGAL_RESOLUTION = 6 , PUC_ERROR_ILLEGAL_FRAME_RATE = 7 ,   PUC_ERROR_ILLEGAL_EXPOSE_CLOCK = 8 , PUC_ERROR_DEVICE_OPEN = 9 , PUC_ERROR_DEVICE_NOTOPEN = 10 , PUC_ERROR_DEVICE_READ = 11 ,   PUC_ERROR_DEVICE_WRITE = 12 , PUC_ERROR_MODULE_LOAD = 13 , PUC_ERROR_LOCK_TIMEOUT = 14 , PUC_ERROR_GET_CMD = 15 ,   PUC_ERROR_SET_CMD = 16 , PUC_ERROR_NOTEQUAL_READ_SIZE = 17 , PUC_ERROR_NOTEQUAL_WRITE_SIZE = 18 , PUC_ERROR_XFER_DATA_INVALID_HEADER = 19 ,   PUC_ERROR_XFER_DATA_BEGIN = 20 , PUC_ERROR_XFER_DATA_WAIT = 21 , PUC_ERROR_XFER_DATA_FINISH = 22 , PUC_ERROR_XFERRING = 23 ,   PUC_ERROR_RING_BUF_COUNT = 24 , PUC_ERROR_SYNC_EXTERNAL = 25 , PUC_ERROR_NOTSUPPORT = 26 , PUC_ERROR_GPU_DECODE_PROCESS = 27 ,   PUC_ERROR_ALLOCATE_BUFFUER = 28 , PUC_ERROR_FREE_BUFFER = 29 , PUC_ERROR_GPU_SYNCHRONIZE = 30 , PUC_ERROR_GPU_MEMORY_COPY = 31 ,   PUC_ERROR_GPU_UNINITIALIZE =32 }
	Error code. More...

Macro Definition Documentation

PUC_CHK_FAILED

#define PUC_CHK_FAILED

(

res

)

Value:

(res != PUC_SUCCEEDED)

The macro to be positive when an error code is not normal.

Definition at line 219 of file PUCCONST.h.

PUC_CHK_SUCCEEDED

#define PUC_CHK_SUCCEEDED

(

res

)

Value:

(res == PUC_SUCCEEDED)

The macro to be positive when an error code is normal.

Definition at line 216 of file PUCCONST.h.

PUC_MAX_DECODE_THREAD_COUNT

#define PUC_MAX_DECODE_THREAD_COUNT   32

Constant value expressing the thread count for multi thread decoding.

Definition at line 41 of file PUCCONST.h.

PUC_MAX_DEVICE

#define PUC_MAX_DEVICE   16

Maximum number of connectable devices.

Definition at line 17 of file PUCCONST.h.

PUC_MAX_LEN

#define PUC_MAX_LEN   256

Maximum number of characters.

Definition at line 20 of file PUCCONST.h.

PUC_MAX_RING_BUF_COUNT

#define PUC_MAX_RING_BUF_COUNT   65535

Maximum ring buffer count for continuous transfer.

Definition at line 29 of file PUCCONST.h.

PUC_MIN_RING_BUF_COUNT

#define PUC_MIN_RING_BUF_COUNT   4

Minimum ring buffer count for continuous transfer.

Definition at line 26 of file PUCCONST.h.

PUC_Q_COUNT

#define PUC_Q_COUNT   64

Quantization table count (8*8)

Definition at line 23 of file PUCCONST.h.

PUC_SYNC_OUT_MAGNIFICATION_0_5

#define PUC_SYNC_OUT_MAGNIFICATION_0_5   0

Constant value expressing the output magnification rate of synchronization signal is 0.5.

Definition at line 38 of file PUCCONST.h.

PUC_XFER_TIMEOUT_AUTO

#define PUC_XFER_TIMEOUT_AUTO   0

Mode for automatically setting the timeout duration (ms) based on the frame rate when no response is received from the device.

Definition at line 32 of file PUCCONST.h.

PUC_XFER_TIMEOUT_INFINITE

#define PUC_XFER_TIMEOUT_INFINITE   0xFFFFFFFF

Mode for setting the timeout duration (ms) to infinite when no response is received from the device.

Definition at line 35 of file PUCCONST.h.

Typedef Documentation

PPUC_HANDLE

typedef PUC_HANDLE* PPUC_HANDLE

Pointer for the device handle.

Definition at line 97 of file PUCCONST.h.

PUC_HANDLE

typedef void* PUC_HANDLE

Device handle.

Definition at line 94 of file PUCCONST.h.

Enumeration Type Documentation

PUC_COLOR_TYPE

enum PUC_COLOR_TYPE

Enumeration for device color/monochrome setting.

Enumerator
PUC_COLOR_MONO	Monochrome.
PUC_COLOR_COLOR	Color.

Definition at line 82 of file PUCCONST.h.

PUC_MODE

enum PUC_MODE

Enumeration for ON/OFF setting.

Enumerator
PUC_OFF	OFF.
PUC_ON	ON.

Definition at line 46 of file PUCCONST.h.

PUC_SIGNAL

enum PUC_SIGNAL

Enumeration for signal polarity.

Enumerator
PUC_SIGNAL_POSI	Positive polarity signal.
PUC_SIGNAL_NEGA	Negative polarity signal.

Definition at line 58 of file PUCCONST.h.

PUC_SYNC_MODE

enum PUC_SYNC_MODE

Enumeration for synchronization.

Enumerator
PUC_SYNC_INTERNAL	Internal operation.
PUC_SYNC_EXTERNAL	Synchronize to external signal.

Definition at line 70 of file PUCCONST.h.

PUCRESULT

enum PUCRESULT

Error code.

Enumerator
PUC_SUCCEEDED	Succeeded.
PUC_ERROR_UNINITIALIZE	Initialization has not been performed. Please execute the PUC_Initialize function.
PUC_ERROR_INITIALIZED	Initialization is already complete.
PUC_ERROR_NOT_EXIST_DEVICE_NO	The specified device number does not exist.
PUC_ERROR_ILLEGAL_DEVICE_HANDLE	The specified device handle is NULL.
PUC_ERROR_ILLEGAL_ARG	The specified argument is NULL.
PUC_ERROR_ILLEGAL_RESOLUTION	The specified resolution cannot be set.
PUC_ERROR_ILLEGAL_FRAME_RATE	The specified framerate cannot be set.
PUC_ERROR_ILLEGAL_EXPOSE_CLOCK	The specified exposure time or non-exposure time (clock units) cannot be set.
PUC_ERROR_DEVICE_OPEN	Failed to open the device.
PUC_ERROR_DEVICE_NOTOPEN	The device is not open.
PUC_ERROR_DEVICE_READ	Failed to read data from the device.
PUC_ERROR_DEVICE_WRITE	Failed to write data to the device.
PUC_ERROR_MODULE_LOAD	There are modules in the SDK that could not load.
PUC_ERROR_LOCK_TIMEOUT	The exclusive process of the function has timed out.
PUC_ERROR_GET_CMD	Failed to send a GET command to the device.
PUC_ERROR_SET_CMD	Failed to send a SET command to the device.
PUC_ERROR_NOTEQUAL_READ_SIZE	The data of specified size could not be read from the device.
PUC_ERROR_NOTEQUAL_WRITE_SIZE	The data of specified size could not be written to the device.
PUC_ERROR_XFER_DATA_INVALID_HEADER	The header information in the data received from the device is invalid.
PUC_ERROR_XFER_DATA_BEGIN	Unable to start data transfer.
PUC_ERROR_XFER_DATA_WAIT	An unexpected error occurred during waiting for a data transfer from the device.
PUC_ERROR_XFER_DATA_FINISH	The data transfer ended abnormally.
PUC_ERROR_XFERRING	Unable to process as a data transfer is in progress.
PUC_ERROR_RING_BUF_COUNT	The specified ring buffer count is invalid.
PUC_ERROR_SYNC_EXTERNAL	Unable to process as a synchronize to external signal is in progress.
PUC_ERROR_NOTSUPPORT	This function is not supprted.
PUC_ERROR_GPU_DECODE_PROCESS	GPU decode process failed.
PUC_ERROR_ALLOCATE_BUFFUER	Failed to allocate buffer.
PUC_ERROR_FREE_BUFFER	Failed to release the buffer.
PUC_ERROR_GPU_SYNCHRONIZE	Failed to synchronize GPU processing.
PUC_ERROR_GPU_MEMORY_COPY	Failed to copy GPU memory.
PUC_ERROR_GPU_UNINITIALIZE	The setup required for GPU processing is not done, please run PUC_SetupGPUDecode.

Definition at line 101 of file PUCCONST.h.