Azure Kinect Sensor SDK  refs/pull/413/merge
Documentation for https://github.com/Microsoft/Azure-Kinect-Sensor-SDK
All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
k4atypes.h
1 
7 #ifndef K4ATYPES_H
8 #define K4ATYPES_H
9 
10 #ifdef __cplusplus
11 #include <cinttypes>
12 #include <cstddef>
13 #include <cstring>
14 #else
15 #include <inttypes.h>
16 #include <stddef.h>
17 #include <string.h>
18 #include <stdbool.h>
19 #endif
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
34 #define K4A_DECLARE_HANDLE(_handle_name_) \
35  typedef struct _##_handle_name_ \
36  { \
37  size_t _rsvd; \
38  } * _handle_name_;
39 
66 K4A_DECLARE_HANDLE(k4a_device_t);
67 
122 K4A_DECLARE_HANDLE(k4a_capture_t);
123 
173 K4A_DECLARE_HANDLE(k4a_image_t);
174 
195 K4A_DECLARE_HANDLE(k4a_transformation_t);
196 
217 typedef enum
218 {
221 } k4a_result_t;
222 
231 typedef enum
232 {
237 
246 typedef enum
247 {
252 
261 typedef enum
262 {
270 
289 typedef enum
290 {
298 
307 typedef enum
308 {
317 
329 typedef enum
330 {
343 
356 
367 
384 
396 
411 
422 
436 typedef enum
437 {
441 } k4a_fps_t;
442 
461 typedef enum
462 {
472 
488 
498 
505 
512 
519 
529 
539 
546 
557 
572 typedef enum
573 {
577 
586 typedef enum
587 {
595 
606 typedef enum
607 {
615 
629 typedef enum
630 {
638 
647 typedef enum
648 {
652 
661 typedef enum
662 {
667 
688 #define K4A_SUCCEEDED(_result_) (_result_ == K4A_RESULT_SUCCEEDED)
689 
698 #define K4A_FAILED(_result_) (!K4A_SUCCEEDED(_result_))
699 
781 typedef void(k4a_logging_message_cb_t)(void *context,
782  k4a_log_level_t level,
783  const char *file,
784  const int line,
785  const char *message);
786 
807 typedef void(k4a_memory_destroy_cb_t)(void *buffer, void *context);
808 
832 typedef struct _k4a_device_configuration_t
833 {
839 
842 
845 
848 
868 
879 
882 
895 
902 
916 typedef struct _k4a_calibration_extrinsics_t
917 {
918  float rotation[9];
919  float translation[3];
921 
939 typedef union
940 {
942  struct _param
943  {
944  float cx;
945  float cy;
946  float fx;
947  float fy;
948  float k1;
949  float k2;
950  float k3;
951  float k4;
952  float k5;
953  float k6;
954  float codx;
955  float cody;
956  float p2;
957  float p1;
959  } param;
960  float v[15];
962 
980 typedef struct _k4a_calibration_intrinsics_t
981 {
983  unsigned int parameter_count;
986 
997 typedef struct _k4a_calibration_camera_t
998 {
1005 
1014 typedef struct _k4a_calibration_t
1015 {
1027 
1031 
1040 typedef struct _k4a_version_t
1041 {
1042  uint32_t major;
1043  uint32_t minor;
1045  uint32_t iteration;
1046 } k4a_version_t;
1047 
1056 typedef struct _k4a_hardware_version_t
1057 {
1066 
1075 typedef union
1076 {
1078  struct _xy
1079  {
1080  float x;
1081  float y;
1082  } xy;
1083  float v[2];
1084 } k4a_float2_t;
1085 
1094 typedef union
1095 {
1097  struct _xyz
1098  {
1099  float x;
1100  float y;
1101  float z;
1102  } xyz;
1103  float v[3];
1104 } k4a_float3_t;
1105 
1114 typedef struct _k4a_imu_sample_t
1115 {
1116  float temperature;
1122 
1145 #define K4A_DEVICE_DEFAULT (0)
1146 
1155 #define K4A_WAIT_INFINITE (-1)
1156 
1172  false,
1173  0,
1175  0,
1176  false };
1177 
1182 #ifdef __cplusplus
1183 }
1184 #endif
1185 
1186 #endif /* K4ATYPES_H */
Calibration model Brown Conrady (compatible with OpenCV)
Definition: k4atypes.h:635
Depth sensor will be turned off with this setting.
Definition: k4atypes.h:291
k4a_color_resolution_t color_resolution
Color camera resolution for which calibration was obtained.
Definition: k4atypes.h:1029
Calibration type representing device calibration.
Definition: k4atypes.h:1014
The result was successful.
Definition: k4atypes.h:248
The result was successful.
Definition: k4atypes.h:233
uint64_t gyro_timestamp_usec
Timestamp of the gyroscope in microseconds.
Definition: k4atypes.h:1120
float k1
k1 radial distortion coefficient
Definition: k4atypes.h:948
2nd most severe level of debug messaging.
Definition: k4atypes.h:264
k4a_fps_t
Color and depth sensor frame rate.
Definition: k4atypes.h:436
Saturation setting.
Definition: k4atypes.h:511
k4a_calibration_model_type_t type
Type of calibration model used.
Definition: k4atypes.h:982
Number of types excluding unknown type.
Definition: k4atypes.h:613
Gain setting.
Definition: k4atypes.h:545
k4a_depth_mode_t depth_mode
Depth camera mode for which calibration was obtained.
Definition: k4atypes.h:1028
int resolution_height
Resolution height of the calibration sensor.
Definition: k4atypes.h:1002
individual parameter or array representation of intrinsic model.
Definition: k4atypes.h:942
float y
Y component of a vector.
Definition: k4atypes.h:1100
Color image type BGRA32.
Definition: k4atypes.h:383
3nd most severe level of debug messaging.
Definition: k4atypes.h:265
float k6
k6 radial distortion coefficient
Definition: k4atypes.h:953
k4a_image_format_t color_format
Image format to capture with the color camera.
Definition: k4atypes.h:838
k4a_float3_t acc_sample
Accelerometer sample in meters per second squared.
Definition: k4atypes.h:1117
Calibration model is Theta (arctan)
Definition: k4atypes.h:632
Structure to define hardware version.
Definition: k4atypes.h:1056
k4a_result_t
Result code returned by Azure Kinect APIs.
Definition: k4atypes.h:217
The result was a failure.
Definition: k4atypes.h:234
Color image type NV12.
Definition: k4atypes.h:355
Calibration type is unknown.
Definition: k4atypes.h:608
float metric_radius
Max FOV of the camera.
Definition: k4atypes.h:1003
k4a_depth_mode_t
Depth sensor capture modes.
Definition: k4atypes.h:289
2560 * 1440 16:9
Definition: k4atypes.h:312
Brightness setting.
Definition: k4atypes.h:497
5 FPS
Definition: k4atypes.h:438
Handle to an Azure Kinect capture.
Definition: k4atypes.h:122
Powerline frequency setting.
Definition: k4atypes.h:555
set the associated k4a_color_control_command_t to auto
Definition: k4atypes.h:574
k4a_buffer_result_t
Result code returned by Azure Kinect APIs.
Definition: k4atypes.h:231
k4a_version_t audio
Audio device firmware version.
Definition: k4atypes.h:1060
Depth captured at 1024x1024.
Definition: k4atypes.h:295
Most severe level of debug messaging.
Definition: k4atypes.h:263
k4a_calibration_model_type_t
Calibration model type.
Definition: k4atypes.h:629
k4a_wired_sync_mode_t wired_sync_mode
The external synchronization mode.
Definition: k4atypes.h:881
k4a_calibration_intrinsic_parameters_t parameters
Calibration parameters.
Definition: k4atypes.h:984
Contrast setting.
Definition: k4atypes.h:504
Production firmware.
Definition: k4atypes.h:649
White balance setting.
Definition: k4atypes.h:528
The operation timed out.
Definition: k4atypes.h:250
No logging is performed.
Definition: k4atypes.h:268
unsigned int parameter_count
Number of valid entries in parameters.
Definition: k4atypes.h:983
k4a_firmware_build_t firmware_build
Build type reported by the firmware.
Definition: k4atypes.h:1063
k4a_version_t rgb
Color camera firmware version.
Definition: k4atypes.h:1058
Gyroscope sensor.
Definition: k4atypes.h:611
k4a_wired_sync_mode_t
Synchronization mode when connecting two or more devices together.
Definition: k4atypes.h:586
IMU sample.
Definition: k4atypes.h:1114
k4a_depth_mode_t depth_mode
Capture mode for the depth camera.
Definition: k4atypes.h:844
Camera sensor intrinsic calibration data.
Definition: k4atypes.h:980
Depth captured at 640x576.
Definition: k4atypes.h:293
float y
Y component of a vector.
Definition: k4atypes.h:1081
uint32_t subordinate_delay_off_master_usec
The external synchronization timing.
Definition: k4atypes.h:894
Pre-production firmware.
Definition: k4atypes.h:650
Calibration model is unknown.
Definition: k4atypes.h:631
float cy
Principal point in image, y.
Definition: k4atypes.h:945
k4a_calibration_extrinsics_t extrinsics
Extrinsic calibration data.
Definition: k4atypes.h:999
Passive IR only, captured at 1024x1024.
Definition: k4atypes.h:296
k4a_calibration_intrinsics_t intrinsics
Intrinsic calibration data.
Definition: k4atypes.h:1000
30 FPS
Definition: k4atypes.h:440
float x
X component of a vector.
Definition: k4atypes.h:1080
k4a_color_resolution_t color_resolution
Image resolution to capture with the color camera.
Definition: k4atypes.h:841
Camera calibration contains intrinsic and extrinsic calibration information for a camera...
Definition: k4atypes.h:997
uint32_t major
Major version; represents a breaking change.
Definition: k4atypes.h:1042
float z
Z component of a vector.
Definition: k4atypes.h:1101
Extrinsic calibration data.
Definition: k4atypes.h:916
Test signed firmware.
Definition: k4atypes.h:664
float cx
Principal point in image, x.
Definition: k4atypes.h:944
float k3
k3 radial distortion coefficient
Definition: k4atypes.h:950
float k5
k5 radial distortion coefficient
Definition: k4atypes.h:952
XYZ or array representation of vector.
Definition: k4atypes.h:1097
float k4
k4 radial distortion coefficient
Definition: k4atypes.h:951
Image type IR16.
Definition: k4atypes.h:410
float codx
Center of distortion in Z=1 plane, x (only used for Rational6KT)
Definition: k4atypes.h:954
15 FPS
Definition: k4atypes.h:439
1280 * 720 16:9
Definition: k4atypes.h:310
uint64_t acc_timestamp_usec
Timestamp of the accelerometer in microseconds.
Definition: k4atypes.h:1118
uint32_t iteration
Reserved.
Definition: k4atypes.h:1045
k4a_calibration_type_t
Calibration types.
Definition: k4atypes.h:606
The &#39;Sync Out&#39; jack is enabled and synchronization data it driven out the connected wire...
Definition: k4atypes.h:589
float p1
Tangential distortion coefficient 1.
Definition: k4atypes.h:957
2nd least severe level of debug messaging.
Definition: k4atypes.h:266
k4a_firmware_build_t
Firmware build type.
Definition: k4atypes.h:647
The result was a failure.
Definition: k4atypes.h:220
Color image type YUY2.
Definition: k4atypes.h:366
float cody
Center of distortion in Z=1 plane, y (only used for Rational6KT)
Definition: k4atypes.h:955
Exposure time setting.
Definition: k4atypes.h:471
float k2
k2 radial distortion coefficient
Definition: k4atypes.h:949
Microsoft signed firmware.
Definition: k4atypes.h:663
k4a_firmware_signature_t firmware_signature
Signature type of the firmware.
Definition: k4atypes.h:1064
bool synchronized_images_only
Only produce k4a_capture_t objects if they contain synchronized color and depth images.
Definition: k4atypes.h:867
Three dimensional floating point vector.
Definition: k4atypes.h:1094
2048 * 1536 4:3
Definition: k4atypes.h:313
bool disable_streaming_indicator
Streaming indicator automatically turns on when the color or depth camera&#39;s are in use...
Definition: k4atypes.h:900
float temperature
Temperature reading of this sample (Celsius).
Definition: k4atypes.h:1116
Exposure or Framerate priority setting.
Definition: k4atypes.h:487
k4a_color_control_mode_t
Color sensor control mode.
Definition: k4atypes.h:572
4096 * 3072 4:3
Definition: k4atypes.h:315
set the associated k4a_color_control_command_t to manual
Definition: k4atypes.h:575
Handle to an Azure Kinect transformation context.
Definition: k4atypes.h:195
Depth captured at 512x512.
Definition: k4atypes.h:294
Depth image type DEPTH16.
Definition: k4atypes.h:395
k4a_color_resolution_t
Color sensor resolutions.
Definition: k4atypes.h:307
Unsigned firmware.
Definition: k4atypes.h:665
void() k4a_memory_destroy_cb_t(void *buffer, void *context)
Callback function for a memory object being destroyed.
Definition: k4atypes.h:807
3840 * 2160 16:9
Definition: k4atypes.h:314
Color camera will be turned off with this setting.
Definition: k4atypes.h:309
The result was successful.
Definition: k4atypes.h:219
k4a_fps_t camera_fps
Desired frame rate for the color and depth camera.
Definition: k4atypes.h:847
k4a_calibration_camera_t color_camera_calibration
Color camera calibration.
Definition: k4atypes.h:1018
float fy
Focal length y.
Definition: k4atypes.h:947
1920 * 1080 16:9
Definition: k4atypes.h:311
Accelerometer sensor.
Definition: k4atypes.h:612
float p2
Tangential distortion coefficient 2.
Definition: k4atypes.h:956
Backlight compensation setting.
Definition: k4atypes.h:538
int32_t depth_delay_off_color_usec
Desired delay between the capture of the color image and the capture of the depth image...
Definition: k4atypes.h:878
Calibration model Polynomial 3K.
Definition: k4atypes.h:633
XY or array representation of vector.
Definition: k4atypes.h:1078
k4a_firmware_signature_t
Firmware signature type.
Definition: k4atypes.h:661
float fx
Focal length x.
Definition: k4atypes.h:946
int resolution_width
Resolution width of the calibration sensor.
Definition: k4atypes.h:1001
Depth captured at 320x288.
Definition: k4atypes.h:292
k4a_float3_t gyro_sample
Gyro sample in radians per second.
Definition: k4atypes.h:1119
Color sensor.
Definition: k4atypes.h:610
k4a_calibration_camera_t depth_camera_calibration
Depth camera calibration.
Definition: k4atypes.h:1016
float metric_radius
Metric radius.
Definition: k4atypes.h:958
Handle to an Azure Kinect device.
Definition: k4atypes.h:66
Depth sensor.
Definition: k4atypes.h:609
Two dimensional floating point vector.
Definition: k4atypes.h:1075
void() k4a_logging_message_cb_t(void *context, k4a_log_level_t level, const char *file, const int line, const char *message)
Callback function for debug messages being generated by the Azure Kinect SDK.
Definition: k4atypes.h:781
Handle to an Azure Kinect image.
Definition: k4atypes.h:173
Least severe level of debug messaging.
Definition: k4atypes.h:267
k4a_version_t depth_sensor
Depth sensor firmware version.
Definition: k4atypes.h:1061
Configuration parameters for an Azure Kinect device.
Definition: k4atypes.h:832
The result was a failure.
Definition: k4atypes.h:249
static const k4a_device_configuration_t K4A_DEVICE_CONFIG_INIT_DISABLE_ALL
Initial configuration setting for disabling all sensors.
Definition: k4atypes.h:1168
Neither &#39;Sync In&#39; or &#39;Sync Out&#39; connections are used.
Definition: k4atypes.h:588
The input buffer was too small.
Definition: k4atypes.h:235
k4a_log_level_t
Verbosity levels of debug messaging.
Definition: k4atypes.h:261
Calibration model Rational 6KT.
Definition: k4atypes.h:634
k4a_color_control_command_t
Color sensor control commands.
Definition: k4atypes.h:461
Custom image format.
Definition: k4atypes.h:420
The &#39;Sync In&#39; jack is used for synchronization and &#39;Sync Out&#39; is driven for the next device in the ch...
Definition: k4atypes.h:591
Sharpness setting.
Definition: k4atypes.h:518
Camera intrinsic calibration data.
Definition: k4atypes.h:939
uint32_t minor
Minor version; represents additional features, no regression from lower versions with same major vers...
Definition: k4atypes.h:1043
k4a_wait_result_t
Result code returned by Azure Kinect APIs.
Definition: k4atypes.h:246
float x
X component of a vector.
Definition: k4atypes.h:1099
k4a_image_format_t
Image format type.
Definition: k4atypes.h:329
k4a_version_t depth
Depth camera firmware version.
Definition: k4atypes.h:1059
Color image type MJPG.
Definition: k4atypes.h:342
Version information.
Definition: k4atypes.h:1040