OrbbecSDK  1.0.0
ObTypes.h
浏览该文件的文档.
1 // License: Apache 2.0. See LICENSE file in root directory.
2 // Copyright(c) 2020 Orbbec Corporation. All Rights Reserved.
3 
9 #pragma once
10 
11 #if ( defined( WIN32 ) || defined( _WIN32 ) || defined( WINCE ) )
12 #ifdef OB_EXPORTS
13 #define OB_EXTENSION_API __declspec( dllexport )
14 #else
15 #define OB_EXTENSION_API __declspec( dllimport )
16 #endif
17 #else
18 #define OB_EXTENSION_API
19 #endif
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 #include "InternalTypes.h"
25 
26 #include <stdbool.h>
27 #include <stdint.h>
28 
29 typedef struct ContextImpl ob_context;
30 
31 typedef struct DeviceImpl ob_device;
32 
33 typedef struct DeviceInfoImpl ob_device_info;
34 
35 typedef struct DeviceListImpl ob_device_list;
36 
37 typedef struct SensorImpl ob_sensor;
38 
39 typedef struct SensorListImpl ob_sensor_list;
40 
41 typedef struct StreamProfileImpl ob_stream_profile;
42 
43 typedef struct FrameImpl ob_frame;
44 typedef struct FrameImpl ob_frame_set;
45 
46 typedef struct FilterImpl ob_filter;
47 
48 typedef struct PipelineImpl ob_pipeline;
49 
50 typedef struct ConfigImpl ob_config;
51 
52 typedef struct OBSensorInfo OBSensorInfo;
53 
54 typedef struct OBFrameSet OBFrameSet;
55 typedef struct ConfigImpl OBConfig;
56 
57 typedef void ( *ob_device_changed_callback )( ob_device_list* removed, ob_device_list* added, void* user_data );
58 
59 typedef void ( *ob_frame_callback )( ob_frame* frame, void* user_data );
60 
61 typedef void ( *ob_frame_set_callback )( ob_frame_set* frame_set, void* user_data );
62 
63 typedef void ( *ob_filter_callback )( ob_frame* frame_set, void* user_data );
64 
69 typedef enum {
70  // 0~999为设备端int, bool及float类型控制命令
71  // Device:: get/setxxxProperty、 getxxxPropertyRange (xxx表示数据类型)
72  OB_DEVICE_PROPERTY_FLASH_WRITE_PROTECTION_BOOL = 0, // FLASH写保护开关;0,关闭;1,开启
73  OB_DEVICE_PROPERTY_TEC_ENABLE_BOOL = 1, // TEC开关
74  OB_DEVICE_PROPERTY_LDP_BOOL = 2, // LDP开关
75  OB_DEVICE_PROPERTY_EMITTER_BOOL = 3, // 激光开光
76  OB_DEVICE_PROPERTY_LASER_PULSE_WIDTH_INT = 4, // 读写激光Time值(脉宽),
77  OB_DEVICE_PROPERTY_LASER_CURRENT_FLOAT = 5, // 激光电流
78  OB_DEVICE_PROPERTY_FLOOD_BOOL = 6, // 泛光灯开关
79  OB_DEVICE_PROPERTY_FLOOD_LEVEL_INT = 7, // 泛光灯等级
80  OB_DEVICE_PROPERTY_TEMPERATURE_COMPENSATION_ENABLE_BOOL = 8, // 温度补偿开关
81  OB_DEVICE_PROPERTY_TEMPERATURE_CALIBRATED_IR_FLOAT = 9, // IR标定温度
82  OB_DEVICE_PROPERTY_TEMPERATURE_CALIBRATED_LDMP_FLOAT = 10, // 激光标定温度
83  OB_DEVICE_PROPERTY_TEMPERATURE_COMPENSATION_COEFFICIENT_IR_FLOAT = 11, // IR温补系数
84  OB_DEVICE_PROPERTY_TEMPERATURE_COMPENSATION_COEFFICIENT_LDMP_FLOAT = 12, // 激光温补系数
85  OB_DEVICE_PROPERTY_DEPTH_ALIGN_SOFTWARE_BOOL = 13, // 软件D2C
86  OB_DEVICE_PROPERTY_DEPTH_MIRROR_BOOL = 14, // 深度镜像
87  OB_DEVICE_PROPERTY_DEPTH_FLIP_BOOL = 15, // 深度翻转
88  OB_DEVICE_PROPERTY_DEPTH_POSTFILTER_BOOL = 16, // 深度Postfilter
89  OB_DEVICE_PROPERTY_DEPTH_HOLEFILTER_BOOL = 17, // 深度Holefilter
90  OB_DEVICE_PROPERTY_IR_MIRROR_BOOL = 18, // IR 镜像
91  OB_DEVICE_PROPERTY_IR_FLIP_BOOL = 19, // IR 翻转
92  OB_DEVICE_PROPERTY_IR_SWITCH_BOOL = 20, // IR 左右切换
93  OB_DEVICE_PROPERTY_HARDWARE_SYNC_BOOL = 21, // 开启硬件同步
94  OB_DEVICE_PROPERTY_MIN_DEPTH_INT = 22, // 最小深度阈值
95  OB_DEVICE_PROPERTY_MAX_DEPTH_INT = 23, // 最大深度阈值
96  OB_DEVICE_PROPERTY_DEPTH_SOFT_FILTER_BOOL = 24, // 软件滤波开关
97  OB_DEVICE_PROPERTY_ZERO_PLANE_DISTANCE_FLOAT = 25, // ZPD
98  OB_DEVICE_PROPERTY_ZERO_PLANE_PIXEL_SIZE_FLOAT = 26, // ZPPS
99  OB_DEVICE_PROPERTY_CHIP_TYPE_INT = 27, // 芯片类型
100  OB_DEVICE_PROPERTY_USB_SPEED_INT = 28, // usb speed
101  OB_DEVICE_PROPERTY_SOFT_RESET_BOOL = 29, // 软件复位
102  OB_DEVICE_PROPERTY_LDP_THRES_UP_INT = 30, // LDP阈值的上限
103  OB_DEVICE_PROPERTY_LDP_THRES_LOW_INT = 31, // LDP阈值的下限
104  OB_DEVICE_PROPERTY_LDP_STATUS_BOOL = 32, // LDP状态
105  OB_DEVICE_PROPERTY_LASER_TEMPERATURE_FLOAT = 33, // 获取激光温度
106  OB_DEVICE_PROPERTY_BOOTLOADER_WRITE_PROTECTION_STATUS_BOOL = 34, // Bootloader区flash写保护状态
107  OB_DEVICE_PROPERTY_RT_IR_TEMP_FLOAT = 35, // 获取实时IR温度
108  OB_DEVICE_PROPERTY_RT_LDMP_TEMP_FLOAT = 36, // 获取实时LDMP温度
109  OB_DEVICE_PROPERTY_RT_RGB_TEMP_FLOAT = 37, // 获取实时RGB温度
110  OB_DEVICE_PROPERTY_STOP_DEPTH_STREAM_BOOL = 38, // 关闭深度流,用于无法通过标准UVC协议关流的设备
111  OB_DEVICE_PROPERTY_STOP_IR_STREAM_BOOL = 39, // 关闭IR流用于无法通过标准UVC协议关流的设备
112  OB_DEVICE_PROPERTY_DEPTH_MAX_DIFF_INT = 40, // soft filter maxdiff param
113  OB_DEVICE_PROPERTY_DEPTH_MAX_SPECKLE_SIZE_INT = 41, // soft filter maxSpeckleSize
114  OB_DEVICE_PROPERTY_DEPTH_ALIGN_HARDWARE_BOOL = 42, // 硬件d2c开
115  OB_DEVICE_PROPERTY_TIMESTAMP_OFFSET_INT = 43, // 时间戳调校
116  OB_DEVICE_PROPERTY_ORIENTATION_SWITCH_BOOL = 44, // 横竖屏切换, 0:竖屏,1横屏
117  OB_DEVICE_PROPERTY_ENABLE_CALIBRATION_BOOL = 45, // 是否需要裁剪
118  // OB_DEVICE_PROPERTY_TOF_FPS_INT = 46, // TOF帧率
119  OB_DEVICE_PROPERTY_TOF_EXPOSURE_TIME_INT = 47, // TOF曝光时间
120  OB_DEVICE_PROPERTY_TOF_GAIN_INT = 48, // TOF增益
121  OB_DEVICE_PROPERTY_TOF_MIRROR_INT = 49, // TOF镜像开光, 0: close 1:H-Mirror 2: V-Mirror 3:H-V-Mirror
122  OB_DEVICE_PROPERTY_TOF_GAUSSIAN_FILTER_BOOL = 50, // 噪声滤波开关
123  OB_DEVICE_PROPERTY_TOF_SCATTER_FILTER_BOOL = 51, // 散射滤波开关
124  OB_DEVICE_PROPERTY_TOF_BILATERAL_FILTER_BOOL = 52, // 双边滤波开关
125  OB_DEVICE_PROPERTY_TOF_FLY_POINT_FILTER_BOOL = 53, // 点云滤波开关
126  OB_DEVICE_PROPERTY_TOF_MEDIAN_FILTER_BOOL = 54, // 中值滤波开关
127  OB_DEVICE_PROPERTY_TOF_CONFIDENCE_FILTER_BOOL = 55, // 置信滤波开关
128  OB_DEVICE_PROPERTY_TOF_SHUFFLE_MODE_BOOL = 56, // TOF Phase Shuffle模式
129  OB_DEVICE_PROPERTY_REBOOT_DEVICE_BOOL = 57, // 设备重启
130  OB_DEVICE_PROPERTY_FACTORY_RESET_BOOL = 58, // 恢复出厂设置
131  OB_DEVICE_PROPERTY_IR_MODE_SWITCH_BOOL = 59, // IR模式 散斑(false)/纯净图(true) 切换
132  OB_DEVICE_PROPERTY_FRAME_RATE_MODE_SWITCH_BOOL = 60, // 帧率 固定模式(false)/动态调整模式(true) 切换
133  OB_DEVICE_PROPERTY_HARDWARE_DISTORTION_SWITCH_BOOL = 61, // 硬件去畸变开关
134  OB_DEVICE_PROPERTY_FAN_WORK_MODE_INT = 62, // 风扇开关模式
135  OB_DEVICE_PROPERTY_DEPTH_ALIGN_HARDWARE_MODE_INT = 63, // 多分辨率D2C模式
136  OB_DEVICE_PROPERTY_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL = 64, // 防串货状态
137  OB_DEVICE_PROPERTY_SOFTWARE_DISTORTION_SWITCH_BOOL = 65, // 软件去畸变开关 OBBoolPropertyRangeTran
138  OB_DEVICE_PROPERTY_SYNC_MODE_INT = 66, // (倚天剑已弃用)同步模式 OBIntPropertyRangeTran
139  OB_DEVICE_PROPERTY_SYNC_EXT_OUT_DELAY_TIME_INT = 67, // (倚天剑已弃用)配置同步信号延时us数后再triggler out输出 OBIntPropertyRangeTran
140  OB_DEVICE_PROPERTY_IR_FRAME_RATE_INT = 68, // IR帧率设置,用于无法通过标准UVC协议设置帧率的设备
141  OB_DEVICE_PROPERTY_DEPTH_FRAME_RATE_INT = 69, // Depth帧率设置,用于无法通过标准UVC协议设置帧率的设备
142  OB_DEVICE_PROPERTY_TEC_MAX_CURRENT_INT = 70, // TEC 最大电流 -> 百分比 0~100%
143  OB_DEVICE_PROPERTY_TEC_MAX_CURRENT_CONFIG_INT = 71, // TEC最大电流配置(掉电保存)
144  OB_DEVICE_PROPERTY_FAN_WORK_MODE_CONFIG_INT = 72, // 风扇开关模式配置(掉电保存)
145  OB_DEVICE_PROPERTY_DEPTH_BIT_PER_PIXEL_INT = 73, // Depth像素位数配置, 8/12/14/16 等,单位为bpp。实际图像帧中每像素占用的位数可以大于实际像素位数(如16bit深度图,有效像素位数为10bit)
146  OB_DEVICE_PROPERTY_IR_BIT_PER_PIXEL_INT = 74, // IR像素位数配置, 8/12/14/16 等,单位为bpp
147  OB_DEVICE_PROPERTY_DEPTH_UNIT_INT = 75, // 深度单位,mx6600: 0: 0.1mm, 1: 0.2mm, 2: 0.4mm, 3: 0.8mm, 4: 1.6mm -> 2^n/10mm
148  OB_DEVICE_PROPERTY_TOF_FILTER_RANGE_INT = 76, // tof滤波场景范围配置
149  OB_DEVICE_PROPERTY_STOP_COLOR_STREAM_BOOL = 77, // 关闭Color流,用于无法通过标准UVC协议关流的设备
150 
151  // 1000~1999为设备端结构体控制命令
152  // Device:: get/setStructedData
153  OB_DATA_TYPE_VERSIONS = 1000, // 版本信息
154  OB_DATA_TYPE_CAMERA_PARA = 1001, // 相机内外参数
155  OB_DATA_TYPE_BASELINE_CALIBRATION_PARA = 1002, // 基线标定参数
156  OB_DATA_TYPE_DEVICE_TEMPERATURE = 1003, // 设备温度信息
157  OB_DATA_TYPE_DEVICE_AE_PARAMS = 1004, // AE调试参数
158  OB_DATA_TYPE_EXTENSION_PARAMS = 1005, // 扩展参数
159  OB_DATA_TYPE_DEVICE_UPGRADE_STATUS = 1006, // 固件升级状态 read only
160  OB_DATA_TYPE_DEVICE_CALIBRATION_UPGRADE_STATUS = 1007, // 标定文件升级状态 read only
161  OB_DATA_TYPE_DEVICE_FILE_TRAN_STATUS = 1008, // 文件传输状态 read only
162  OB_DATA_TYPE_PTZ_CONTROL = 1009, // 云台控制
163  OB_DATA_TYPE_DIGITAL_ZOOM = 1010, // 数字变焦
164  OB_DATA_TYPE_TOF_TX_RX_TEMP = 1011, // TOF tx rx温度
165  OB_DATA_TYPE_TOF_MODULATION_FREQ = 1012, // TOF调制频率信息
166  OB_DATA_TYPE_TOF_DUTY_CYCLE = 1013, // TOF调制信号占空比信息
167  OB_DATA_TYPE_TOF_CALIBRATION_PARA = 1014, // TOF标定参数
168  OB_DATA_TYPE_TOF_DEPTH_COEF_PARA = 1015, // TOF距离转深度系数
169  OB_DATA_TYPE_TOF_VCSEL_TEMP_COMPENSATION = 1016, // TOF温补系数
170  OB_DATA_TYPE_TOF_GAUSSIAN_FILTER_PARA = 1017, // TOF高斯噪声滤波参数
171  OB_DATA_TYPE_TOF_SCATTER_FILTER_PARA = 1018, // TOF散射滤波参数
172  OB_DATA_TYPE_TOF_BILATERAL_FILTER_PARA = 1019, // TOF双边滤波参数
173  OB_DATA_TYPE_TOF_FLY_POINT_FILTER_PARA = 1020, // TOF点云滤波参数
174  OB_DATA_TYPE_TOF_MEDIAN_FILTER_PARA = 1021, // TOF中值滤波参数
175  OB_DATA_TYPE_TOF_CONFIDENCE_FILTER_PARA = 1022, // TOF置信滤波参数
176  OB_DATA_TYPE_TOF_NEAREST_FARTHEST_LENGTH = 1023, // TOF最近与最远距离
177  OB_DATA_TYPE_TOF_EXPOSURE_THRESHOLD_CONTROL = 1024, // TOF曝光阈值范围
178  OB_DATA_TYPE_DEVICE_STATE = 1025, // 获取当前设备状态
179  OB_DATA_TYPE_TEC_DATA = 1026, // 获取TEC数据
180  OB_DATA_TYPE_GPM_CONFIG_DATA = 1027, // GPM配置数据,包括16个坐标和相关的阈值
181  OB_DATA_TYPE_GPM_STATUS_DATA = 1028, // 获取GPM状态数据,包括16个点机及其统计信息
182  OB_DATA_TYPE_ANTI_COLLUSION_ACTIVATION_CONTENT = 1029, // 防串货激活码读写
183  OB_DATA_TYPE_ANTI_COLLUSION_ACTIVATION_VERIFY = 1030, // 防串货激活码验证
184  OB_DATA_TYPE_GET_GYRO_PRESETS_ODR_LIST = 1031, // 获取陀螺仪支持的采样率列表
185  OB_DATA_TYPE_GET_ACCEL_PRESETS_ODR_LIST = 1032, // 获取加速度计支持的采样率列表
186  OB_DATA_TYPE_GET_GYRO_PRESETS_FULL_SCALE_LIST = 1033, // 获取陀螺仪支持的量程列表
187  OB_DATA_TYPE_GET_ACCEL_PRESETS_FULL_SCALE_LIST = 1034, // 获取加速度计支持的量程列表
188  OB_DATA_TYPE_DEVICE_SERIAL_NUMBER = 1035, // get/set序列号
189  OB_DATA_TYPE_DEVICE_PRODUCT_NUMBER = 1036, // get/set PN
190  OB_DATA_TYPE_DEVICE_TIME = 1037, // get/set device time
191  OB_DATA_TYPE_TOF_MULTI_DEVICE_SYNC_CONFIG = 1038, // 多设备同步模式和参数配置
192  OB_DATA_TYPE_TEMP_COMPENSATE_PARA = 1039, // get/set 温度补偿系数
193 
194  // 2000~2999为Sensor控制命令
195  // Device:: get/setxxxProperty、 getxxxPropertyRange (xxx表示数据类型)
196  OB_SENSOR_PROPERTY_ENABLE_AUTO_EXPOSURE_BOOL = 2000, // 自动曝光
197  OB_SENSOR_PROPERTY_EXPOSURE_INT = 2001, // 曝光调节
198  OB_SENSOR_PROPERTY_GAIN_INT = 2002, // 增益调节
199  OB_SENSOR_PROPERTY_ENABLE_AUTO_WHITE_BALANCE_BOOL = 2003, // 自动白平衡
200  OB_SENSOR_PROPERTY_WHITE_BALANCE_INT = 2004, // 白平衡调节
201  OB_SENSOR_PROPERTY_BRIGHTNESS_INT = 2005, // 亮度调节
202  OB_SENSOR_PROPERTY_SHARPNESS_INT = 2006, // 锐度调节
203  // 用白平衡调节代替色温调节
204  // OB_SENSOR_PROPERTY_COLOR_TEMPERATURE_INT = 2007, // 色温调节
205  OB_SENSOR_PROPERTY_SATURATION_INT = 2008, // 饱和度调节
206  OB_SENSOR_PROPERTY_CONTRAST_INT = 2009, // 对比度调节
207  OB_SENSOR_PROPERTY_GAMMA_INT = 2010, // 伽马值调节
208  OB_SENSOR_PROPERTY_ROLL_INT = 2011, // 图像旋转
209  OB_SENSOR_PROPERTY_AUTO_EXPOSURE_PRIORITY_INT = 2012, // 自动曝光优先
210  OB_SENSOR_PROPERTY_BACKLIGHT_COMPENSATION_INT = 2013, // 亮度补偿
211  OB_SENSOR_PROPERTY_HUE_INT = 2014, // 彩色色调
212  OB_SENSOR_PROPERTY_POWER_LINE_FREQUENCY_INT = 2015, // 电力线路频率
213  // MIRROR 和 FLIP 通过私有协议控制命令实现
214  // OB_SENSOR_PROPERTY_MIRROR_BOOL = 2016, // 图像镜像
215  // OB_SENSOR_PROPERTY_FLIP_BOOL = 2017, // 图像翻转
216  // 以上Sensor控制命令会被转换成标准UVC控制协议命令
217  // OB_SENSOR_PROPERTY_ID_INT = 2018, // SensorID
218  OB_SENSOR_PROPERTY_GYRO_SWITCH_BOOL = 2019, // 陀螺仪开关
219  OB_SENSOR_PROPERTY_ACCEL_SWITCH_BOOL = 2020, // 加速度计开关
220  OB_SENSOR_PROPERTY_GYRO_ODR_INT = 2021, // get/set当前陀螺仪的采样率
221  OB_SENSOR_PROPERTY_ACCEL_ODR_INT = 2022, // get/set当前加速度计的采样率
222  OB_SENSOR_PROPERTY_GYRO_FULL_SCALE_INT = 2023, // get/set当前陀螺仪的量程
223  OB_SENSOR_PROPERTY_ACCEL_FULL_SCALE_INT = 2024, // get/set当前加速度计的量程
224 
225  // 3000~3499为SDK int, bool及float类型控制命令
226  // Device:: get/setxxxProperty、 getxxxPropertyRange (xxx表示数据类型)
227  OB_SDK_PROPERTY_DEPTH_SOFT_FILTER_BOOL = 3000, // 软件滤波开关
228  OB_SDK_PROPERTY_DEPTH_MAX_DIFF_INT = 3001, // soft filter maxdiff param
229  OB_SDK_PROPERTY_DEPTH_MAX_SPECKLE_SIZE_INT = 3002, // soft filter maxSpeckleSize
230  OB_SDK_PROPERTY_SOFT_FILTER_TYPE_BOOL = 3003, // soft filter filterType ,0-disparity 1-depth
231  OB_SDK_PROPERTY_DISPARITY_TO_DEPTH_BOOL = 3004, // convert disparity to depth
232  OB_SDK_PROPERTY_IR_MIRROR_BOOL = 3005, // SDK ir mirror
233  OB_SDK_PROPERTY_DEPTH_RLE_DECODE_BOOL = 3006, // DEPTH RLE decode使能(开深度RLE流时有效)
234 
235  // 3500~3999为SDK结构体控制命令
236  OB_SDK_DATA_DEPTH_VALUE_LIMIT_RANGE = 3500, // DEPTH VALUE LIMIT(深度最大值、最小值, unit: mm)
237 
238  // 4000~4999为RawData控制命令
239  // Device:: get/setRawData
240  OB_RAW_DATA_MULTIPLE_DISTANCE_CALIBRATION_PARA = 4000, // 多距离标定参数
241  OB_RAW_DATA_REFERENCE_IMAGE = 4001, // 参考图
242  OB_RAW_DATA_CAMERA_CFG_PARAMETER_960_1280 = 4002, // 对应960_1280分辨率的相机配置参数 write only
243  OB_RAW_DATA_CAMERA_CFG_PARAMETER_720_1280 = 4003, // 对应720_1280分辨率的相机配置参数 write only
244  OB_RAW_DATA_CAMERA_CFG_PARAMETER_1280_720 = 4004, // 对应720_1280分辨率的相机配置参数 write only
245  OB_RAW_DATA_HARDWARE_ALIGN_PARA = 4005, // 硬件对齐参数
246  OB_RAW_DATA_SOFTWARE_ALIGN_PARA = 4006, // 软件对齐参数
247  OB_RAW_DATA_HARDWARE_DISTORTION_PARA = 4007, // 硬件去畸变参数
248  OB_RAW_DATA_DEPTH_CONFIG_PARA = 4008, // Config区
249  OB_RAW_DATA_HARDWARE_ALIGN_PARA_0 = 4009, // 硬件对齐参数0, 适用与多分辨率对齐场景,由设备决定HARDWARE_ALIGN_PARA_xxx 与分辨率的映射关系
250  OB_RAW_DATA_HARDWARE_ALIGN_PARA_1 = 4010, // 硬件对齐参数1
251  OB_RAW_DATA_HARDWARE_ALIGN_PARA_2 = 4011, // 硬件对齐参数2
252  OB_RAW_DATA_HARDWARE_ALIGN_PARA_3 = 4012, // 硬件对齐参数3
253  OB_RAW_DATA_HARDWARE_ALIGN_PARA_4 = 4013, // 硬件对齐参数4
254  OB_RAW_DATA_HARDWARE_ALIGN_PARA_5 = 4014, // 硬件对齐参数5
255  OB_RAW_DATA_TEMP_COMPENSATE_PARA = 4015, // 温补参数
256  OB_RAW_DATA_SOFTWARE_ALIGN_PARA_0 = 4016, // 软件对齐参数0, 适用与多分辨率对齐场景,由设备决定HARDWARE_ALIGN_PARA_xxx 与分辨率的映射关系
257  OB_RAW_DATA_SOFTWARE_ALIGN_PARA_1 = 4017, // 软件对齐参数1
258  OB_RAW_DATA_SOFTWARE_ALIGN_PARA_2 = 4018, // 软件对齐参数2
259  OB_RAW_DATA_SOFTWARE_ALIGN_PARA_3 = 4019, // 软件对齐参数3
260  OB_RAW_DATA_SOFTWARE_ALIGN_PARA_4 = 4020, // 软件对齐参数4
261  OB_RAW_DATA_SOFTWARE_ALIGN_PARA_5 = 4021, // 软件对齐参数5
262  OB_RAW_DATA_DEPTH_CALIB_FLASH_FILE = 4022, // 深度标定参数文件(MX6600)
263  OB_RAW_DATA_ALIGN_CALIB_FLASH_FILE = 4023, // 对齐标定参数文件(MX6600)
264 
265  // 5000~5499为调试用int, bool及float类型控制命令
266  // Device:: get/setxxxProperty、 getxxxPropertyRange (xxx表示数据类型)
267  OB_DEVICE_DEBUG_ADB_FUNCTION_CONTROL_BOOL = 5000, // ADB调试功能开关
268  OB_DEVICE_DEBUG_SET_FORCE_UPGRADE_BOOL = 5001, // 强制升级
269  OB_DEVICE_DEBUG_MX6300_START_TIME_INT = 5002, // 获取MX6300固件启动时间
270 
271  // 5500~5999为调试用结构体控制命令
272  // Device:: get/setStructedData
273  OB_DEVICE_DEBUG_RECORD_RGB_DATA = 5500, // 设备端 RGB 传图控制(调试功能)
274  OB_DEVICE_DEBUG_RECORD_PHASE_DATA = 5501, // 设备端 raw Phase 传图控制(调试功能)
275  OB_DEVICE_DEBUG_RECORD_IR_DATA = 5502, // 设备端 IR 传图控制(调试功能)
276  OB_DEVICE_DEBUG_RECORD_DEPTH_DATA = 5503, // 设备端 depth 传图控制(调试功能)
277 
279  ob_global_unified_property;
280 
285 typedef enum { OB_STATUS_OK = 0, OB_STATUS_ERROR = 1 } ob_status, OBStatus;
286 
291 typedef enum {
292  OB_LOG_SEVERITY_DEBUG,
293  OB_LOG_SEVERITY_INFO,
294  OB_LOG_SEVERITY_WARN,
295  OB_LOG_SEVERITY_ERROR,
296  OB_LOG_SEVERITY_FATAL,
297  OB_LOG_SEVERITY_NONE,
298  OB_LOG_SEVERITY_COUNT
300  OBLogServerity;
301 
307 typedef enum {
308  OB_EXCEPTION_TYPE_UNKNOWN, //未知错误,SDK未明确定义的错误
309  OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED, // SDK的设备断开的异常
310  OB_EXCEPTION_TYPE_PLATFORM, //在SDK适配平台层错误,代表是具体一个系统平台实现上错误
311  OB_EXCEPTION_TYPE_INVALID_VALUE, //无效的参数类型异常,需要检查输入参数
312  OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE, // API版本不匹配带来的异常
313  OB_EXCEPTION_TYPE_NOT_IMPLEMENTED, // SDK及固件还未实现功能
314  OB_EXCEPTION_TYPE_IO, // SDK访问IO异常错误
315  OB_EXCEPTION_TYPE_MEMORY, // SDK的访问和使用内存错误,代表桢分配内存失败
316  OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION, // SDK或RGBD设备不支持的操作类型错误
317  OB_EXCEPTION_TYPE_COUNT
319  OBExceptionType;
320 
329 typedef struct ob_error {
330  ob_status status;
331  char message[ 256 ];
332  char function[ 256 ];
333  char args[ 256 ];
334  ob_exception_type exception_type;
335 } ob_error;
336 
341 typedef enum {
342  OB_SENSOR_UNKNOWN = 0,
343  OB_SENSOR_IR = 1,
344  OB_SENSOR_COLOR = 2,
345  OB_SENSOR_DEPTH = 3,
346  OB_SENSOR_IMU = 4,
348  OBSensorType;
349 
353 typedef enum {
354  OB_STREAM_VIDEO = 0,
355  OB_STREAM_IR = 1,
356  OB_STREAM_COLOR = 2,
357  OB_STREAM_DEPTH = 3,
358  OB_STREAM_IMU = 4,
360  OBStreamType;
361 
366 typedef enum {
367  OB_FRAME_VIDEO = 0,
368  OB_FRAME_IR = 1,
369  OB_FRAME_COLOR = 2,
370  OB_FRAME_DEPTH = 3,
371  OB_FRAME_IMU = 4,
372  OB_FRAME_SET = 5,
373  OB_FRAME_POINTS = 6,
374 } ob_frame_type,
375  OBFrameType;
376 
381 typedef enum {
382  OB_FORMAT_YUYV = 0,
383  OB_FORMAT_YUY2,
384  OB_FORMAT_UYVY,
385  OB_FORMAT_NV12,
386  OB_FORMAT_NV21,
387  OB_FORMAT_MJPG,
388  OB_FORMAT_H264,
389  OB_FORMAT_H265,
390  OB_FORMAT_Y16,
391  OB_FORMAT_Y8,
392  OB_FORMAT_Y10,
393  OB_FORMAT_Y11,
394  OB_FORMAT_Y12,
395  OB_FORMAT_GRAY,
396  OB_FORMAT_HEVC,
397  OB_FORMAT_I420,
398  OB_FORMAT_ACCEL,
399  OB_FORMAT_GYRO,
400  OB_FORMAT_IMU,
401  OB_FORMAT_POINT,
402  OB_FORMAT_RGB_POINT,
403  OB_FORMAT_RLE,
404  OB_FORMAT_UNKNOWN,
405 } ob_format,
406  OBFormat;
407 
408 typedef enum {
409  STAT_FILE_TRANSFER = 4,
410  STAT_DONE = 3,
411  STAT_IN_PROGRESS = 2,
412  STAT_START = 1,
413  STAT_VERIFY_IMAGE = 0,
414  ERR_VERIFY = -1,
415  ERR_PROGRAM = -2,
416  ERR_ERASE = -3,
417  ERR_FLASH_TYPE = -4,
418  ERR_IMG_SIZE = -5,
419  ERR_OTHER = -6,
420  ERR_DDR = -7,
421  ERR_TIMEOUT = -8
422 } OBUpgradeState,
423  ob_upgrade_state;
424 
425 typedef enum {
426  FILE_TRAN_STAT_TRANSFER = 2,
427  FILE_TRAN_STAT_DONE = 1,
428  FILE_TRAN_STAT_PREPAR = 0,
429  FILE_TRAN_ERR_DDR = -1,
430  FILE_TRAN_ERR_NOT_ENOUGH_SPACE = -2,
431  FILE_TRAN_ERR_PATH_NOT_WRITABLE = -3,
432  FILE_TRAN_ERR_MD5_ERROR = -4,
433  FILE_TRAN_ERR_WRITA_FLASH_ERROR = -5,
434  FILE_TRAN_ERR_TIMEOUT = -6
435 } OBFileTranState,
436  ob_file_tran_state;
437 
438 typedef enum {
439  DATA_TRAN_STAT_STOPED = 3,
440  DATA_TRAN_STAT_DONE = 2,
441  DATA_TRAN_STAT_VERIFYING = 1,
442  DATA_TRAN_STAT_TRANSFERING = 0,
443  DATA_TRAN_ERR_BUSY = -1,
444  DATA_TRAN_ERR_UNSUPPORTED = -2,
445  DATA_TRAN_ERR_TRAN_FAILED = -3,
446  DATA_TRAN_ERR_VERIFY_FAILED = -4,
447  DATA_TRAN_ERR_OTHER = -5
448 } OBDataTranState,
449  ob_data_tran_state;
450 
451 typedef struct {
452  void* data; // 当前数据块数据
453  uint32_t size; // 当前数据块大小
454  uint32_t offset; // 当前数据块相对完整数据的偏移
455  uint32_t fullDataSize; // 完整数据大小
457 
458 /*
459  * 以下三个OBxxxxPropertyRangeTran 结构体,用于SDK与设备固件property数据传输
460  * 其成员变量数据类型的长度(4byte)遵循Property命令协议
461  */
462 //整形范围的结构体
463 typedef struct {
464  int32_t cur;
465  int32_t max;
466  int32_t min;
467  int32_t step;
468  int32_t def;
470 
471 //浮点型范围的结构体
472 typedef struct {
473  float cur;
474  float max;
475  float min;
476  float step;
477  float def;
479 
480 // bool型范围的结构体
481 typedef struct {
482  bool cur;
483  bool max;
484  bool min;
485  bool step;
486  bool def;
488 
489 // 相机内参
490 typedef struct {
491  float fx; // x方向焦距,单位:像素
492  float fy; // y方向焦距,单位:像素
493  float cx; // 光心横坐标
494  float cy; // 光心纵坐标
495  int16_t width; // 图像宽度
496  int16_t height; // 图像高度
498 // 去畸变参数
499 typedef struct {
500  float k1;
501  float k2;
502  float k3;
503  float k4;
504  float k5;
505  float k6;
506  float p1;
507  float p2;
509 
510 // 旋转矩阵
511 typedef struct {
512  float rot[ 9 ]; // 旋转矩阵,行优先
513  float trans[ 3 ];
515 
516 typedef void ( *ob_file_send_callback )( ob_file_tran_state state, const char* message, uint8_t percent, void* user_data );
517 typedef void ( *ob_device_upgrade_callback )( ob_upgrade_state state, const char* message, uint8_t percent, void* user_data );
518 typedef void ( *ob_device_state_callback )( ob_device_state state, void* user_data );
519 typedef void ( *ob_set_data_callback )( ob_data_tran_state state, uint8_t percent, void* user_data );
520 typedef void ( *ob_get_data_callback )( ob_data_tran_state state, ob_data_chunk* dataChunk, void* user_data );
521 
522 #ifdef __cplusplus
523 }
524 #endif
ob_status
错误码
Definition: ObTypes.h:285
struct ob_error ob_error
SDK的对外暴露的错误类,用户可以根据该错误类,获取详细的错误信息 ob_status: 描述错误的状态码,作为兼容...
OBGlobalUnifiedProperty
描述设备所有的属性的枚举值
Definition: ObTypes.h:69
ob_exception_type
SDK内部的异常类型,通过异常类型,可以简单判断具体哪个类型的错误 详细的错误API接口函数、错误日志请参考...
Definition: ObTypes.h:307
ob_frame_type
描述Frame类型枚举值
Definition: ObTypes.h:366
ob_log_severity
log等级
Definition: ObTypes.h:291
ob_sensor_type
描述传感器类型的枚举值
Definition: ObTypes.h:341
ob_stream_type
描述数据流类型的枚举值
Definition: ObTypes.h:353
ob_format
描述像素格式的枚举值
Definition: ObTypes.h:381
提供SDK的结构体、枚举常量定义
SDK的对外暴露的错误类,用户可以根据该错误类,获取详细的错误信息 ob_status: 描述错误的状态码,作为兼容...
Definition: ObTypes.h:329