1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
#ifndef __UNIFIED_CAMERA_ACCESS_H
#define __UNIFIED_CAMERA_ACCESS_H
/**
* \file uca.h
* \brief Abstract camera model
*
* The uca_t structure represents a common interface for cameras regardless of
* their connectivity. Each camera that adheres to this model must provide an
* initialization function that probes the device and sets all function pointers
* to their respective implementation.
*/
#include <stdint.h>
struct uca_t;
struct uca_camera_t;
struct uca_property_t;
enum uca_camera_state;
enum uca_property_ids;
/**
* \brief Camera probing and initialization
* \return UCA_ERR_INIT_NOT_FOUND if camera is not found or could not be initialized
*/
typedef uint32_t (*uca_cam_init) (struct uca_camera_t **cam);
/**
* \brief Free camera resouces
*/
typedef uint32_t (*uca_cam_destroy) (struct uca_camera_t *cam);
/**
* \brief Set a property
* \param[in] property_name Name of the property as defined in XXX
* \return UCA_ERR_PROP_INVALID if property is not supported on the camera or
* UCA_ERR_PROP_VALUE_OUT_OF_RANGE if value cannot be set.
*/
typedef uint32_t (*uca_cam_set_property) (struct uca_camera_t *cam, enum uca_property_ids property, void *data);
/**
* \brief Set a property
* \param[in] property_name Name of the property as defined in XXX
* \return UCA_ERR_PROP_INVALID if property is not supported on the camera
*/
typedef uint32_t (*uca_cam_get_property) (struct uca_camera_t *cam, enum uca_property_ids property, void *data);
/** \brief Allocate number of buffers
*
* The size of each buffer is width x height x bits
*/
typedef uint32_t (*uca_cam_alloc) (struct uca_camera_t *cam, uint32_t n_buffers);
/**
* \brief Acquire one frame
*/
typedef uint32_t (*uca_cam_acquire_image) (struct uca_camera_t *cam, void *buffer);
/**
* \brief Initialize the unified camera access interface
* \return Pointer to a uca_t structure
*/
struct uca_t *uca_init(void);
/**
* \brief Free resources of the unified camera access interface
*/
void uca_destroy(struct uca_t *uca);
enum uca_cam_state uca_get_camera_state(struct uca_camera_t *cam);
/**
* \brief Convert a property string to the corresponding ID
*/
enum uca_property_ids uca_get_property_id(const char *property_name);
/**
* \brief Convert a property ID to the corresponding string
*/
const char* uca_get_property_name(enum uca_property_ids property_id);
struct uca_property_t *uca_get_full_property(enum uca_property_ids property_id);
#define UCA_NO_ERROR 0
#define UCA_ERR_INIT_NOT_FOUND 1 /**< camera probing or initialization failed */
#define UCA_ERR_PROP_INVALID 2 /**< the requested property is not supported by the camera */
#define UCA_ERR_PROP_GENERAL 3 /**< error occured reading/writing the property */
#define UCA_ERR_PROP_VALUE_OUT_OF_RANGE 4 /**< error occured writing the property */
/* The property IDs must start with 0 and must be continuous. Whenever this
* library is released, the IDs must not change to guarantee binary compatibility! */
enum uca_property_ids {
UCA_PROP_NAME = 0,
UCA_PROP_WIDTH,
UCA_PROP_WIDTH_MIN,
UCA_PROP_WIDTH_MAX,
UCA_PROP_HEIGHT,
UCA_PROP_HEIGHT_MIN,
UCA_PROP_HEIGHT_MAX,
UCA_PROP_X_OFFSET,
UCA_PROP_Y_OFFSET,
UCA_PROP_BITDEPTH,
UCA_PROP_EXPOSURE,
UCA_PROP_EXPOSURE_MIN,
UCA_PROP_EXPOSURE_MAX,
UCA_PROP_DELAY,
UCA_PROP_DELAY_MIN,
UCA_PROP_DELAY_MAX,
UCA_PROP_FRAMERATE,
UCA_PROP_TRIGGER_MODE,
/* pco.edge specific */
UCA_PROP_TIMESTAMP_MODE,
UCA_PROP_SCAN_MODE,
/* IPE camera specific */
UCA_PROP_INTERLACE_SAMPLE_RATE,
UCA_PROP_INTERLACE_PIXEL_THRESH,
UCA_PROP_INTERLACE_ROW_THRESH,
/* Photon Focus specific */
UCA_PROP_CORRECTION_MODE,
UCA_PROP_LAST
};
/* Possible timestamp modes for UCA_PROP_TIMESTAMP_MODE */
#define UCA_TIMESTAMP_ASCII 0x01
#define UCA_TIMESTAMP_BINARY 0x02
/* Trigger mode for UCA_PROP_TRIGGERMODE */
#define UCA_TRIGGER_AUTO 1
#define UCA_TRIGGER_INTERNAL 2
#define UCA_TRIGGER_EXTERNAL 3
/* Correction modes for UCA_PROP_CORRECTION_MODE */
#define UCA_CORRECT_OFFSET 0x01
#define UCA_CORRECT_HOTPIXEL 0x02
#define UCA_CORRECT_GAIN 0x04
struct uca_property_t {
const char *name;
enum uca_unit {
uca_pixel,
uca_bits,
uca_ns,
uca_us,
uca_ms,
uca_s,
uca_rows,
uca_na
} unit;
enum uca_types {
uca_uint32t,
uca_uint8t,
uca_string
} type;
};
enum uca_cam_state {
UCA_CAM_ERROR,
UCA_CAM_CONFIGURABLE,
UCA_CAM_ARMED,
UCA_CAM_RECORDING,
};
struct uca_camera_t {
struct uca_camera_t *next;
/* Function pointers to camera-specific methods */
uca_cam_set_property set_property;
uca_cam_get_property get_property;
uca_cam_acquire_image acquire_image;
uca_cam_alloc alloc;
/* Private */
uca_cam_destroy destroy;
enum uca_cam_state state;
void *user; /**< private user data to be used by the camera driver */
};
struct uca_t {
struct uca_camera_t *cameras;
};
#endif
|
