Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
rs_sensor.h
Go to the documentation of this file.
1 /* License: Apache 2.0. See LICENSE file in root directory.
2  Copyright(c) 2017 Intel Corporation. All Rights Reserved. */
3 
10 #ifndef LIBREALSENSE_RS2_SENSOR_H
11 #define LIBREALSENSE_RS2_SENSOR_H
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #include "rs_types.h"
18 
22 typedef enum rs2_camera_info {
39 
41 typedef enum rs2_stream
42 {
54 } rs2_stream;
55 const char* rs2_stream_to_string(rs2_stream stream);
56 
58 typedef enum rs2_format
59 {
90 } rs2_format;
91 const char* rs2_format_to_string(rs2_format format);
92 
94 typedef struct rs2_extrinsics
95 {
96  float rotation[9];
97  float translation[3];
99 
104 void rs2_delete_sensor_list(rs2_sensor_list* info_list);
105 
112 int rs2_get_sensors_count(const rs2_sensor_list* info_list, rs2_error** error);
113 
118 void rs2_delete_sensor(rs2_sensor* sensor);
119 
126 rs2_sensor* rs2_create_sensor(const rs2_sensor_list* list, int index, rs2_error** error);
127 
135 
143 const char* rs2_get_sensor_info(const rs2_sensor* sensor, rs2_camera_info info, rs2_error** error);
144 
151 int rs2_supports_sensor_info(const rs2_sensor* sensor, rs2_camera_info info, rs2_error** error);
152 
160 int rs2_is_sensor_extendable_to(const rs2_sensor* sensor, rs2_extension extension, rs2_error** error);
161 
167 float rs2_get_depth_scale(rs2_sensor* sensor, rs2_error** error);
168 
174 float rs2_depth_stereo_frame_get_baseline(const rs2_frame* frame_ref, rs2_error** error);
175 
181 float rs2_get_stereo_baseline(rs2_sensor* sensor, rs2_error** error);
182 
192 void rs2_set_region_of_interest(const rs2_sensor* sensor, int min_x, int min_y, int max_x, int max_y, rs2_error** error);
193 
203 void rs2_get_region_of_interest(const rs2_sensor* sensor, int* min_x, int* min_y, int* max_x, int* max_y, rs2_error** error);
204 
211 void rs2_open(rs2_sensor* device, const rs2_stream_profile* profile, rs2_error** error);
212 
221 void rs2_open_multiple(rs2_sensor* device, const rs2_stream_profile** profiles, int count, rs2_error** error);
222 
228 void rs2_close(const rs2_sensor* sensor, rs2_error** error);
229 
237 void rs2_start(const rs2_sensor* sensor, rs2_frame_callback_ptr on_frame, void* user, rs2_error** error);
238 
245 void rs2_start_cpp(const rs2_sensor* sensor, rs2_frame_callback* callback, rs2_error** error);
246 
253 void rs2_start_queue(const rs2_sensor* sensor, rs2_frame_queue* queue, rs2_error** error);
254 
260 void rs2_stop(const rs2_sensor* sensor, rs2_error** error);
261 
268 void rs2_set_notifications_callback(const rs2_sensor* sensor, rs2_notification_callback_ptr on_notification, void* user, rs2_error** error);
269 
277 
284 const char* rs2_get_notification_description(rs2_notification* notification, rs2_error** error);
285 
293 
301 
309 
316 const char* rs2_get_notification_serialized_data(rs2_notification* notification, rs2_error** error);
317 
325 
332 const rs2_stream_profile* rs2_get_stream_profile(const rs2_stream_profile_list* list, int index, rs2_error** error);
333 
344 void rs2_get_stream_profile_data(const rs2_stream_profile* mode, rs2_stream* stream, rs2_format* format, int* index, int* unique_id, int* framerate, rs2_error** error);
345 
354 void rs2_set_stream_profile_data(rs2_stream_profile* mode, rs2_stream stream, int index, rs2_format format, rs2_error** error);
355 
365 rs2_stream_profile* rs2_clone_stream_profile(const rs2_stream_profile* mode, rs2_stream stream, int index, rs2_format format, rs2_error** error);
366 
379 rs2_stream_profile* rs2_clone_video_stream_profile(const rs2_stream_profile* mode, rs2_stream stream, int index, rs2_format format, int width, int height, const rs2_intrinsics* intr, rs2_error** error);
380 
381 
388 
396 int rs2_stream_profile_is(const rs2_stream_profile* mode, rs2_extension type, rs2_error** error);
397 
405 void rs2_get_video_stream_resolution(const rs2_stream_profile* mode, int* width, int* height, rs2_error** error);
406 
414 
423 
431 
437 
444 void rs2_get_extrinsics(const rs2_stream_profile* from,
445  const rs2_stream_profile* to,
446  rs2_extrinsics* extrin, rs2_error** error);
447 
455  const rs2_stream_profile* to,
456  rs2_extrinsics extrin, rs2_error** error);
457 
464 void rs2_get_video_stream_intrinsics(const rs2_stream_profile* mode, rs2_intrinsics* intrinsics, rs2_error** error);
465 
474 
483 
491 
497 
506 int rs2_import_localization_map(const rs2_sensor* sensor, const unsigned char* lmap_blob, unsigned int blob_size, rs2_error** error);
507 
515 //void rs2_export_localization_map(const rs2_sensor* sensor, const char* lmap_fname, rs2_error** error);
517 
527 int rs2_set_static_node(const rs2_sensor* sensor, const char* guid, const rs2_vector pos, const rs2_quaternion orient, rs2_error** error);
528 
538 int rs2_get_static_node(const rs2_sensor* sensor, const char* guid, rs2_vector *pos, rs2_quaternion *orient, rs2_error** error);
539 
547 int rs2_remove_static_node(const rs2_sensor* sensor, const char* guid, rs2_error** error);
548 
553 int rs2_load_wheel_odometry_config(const rs2_sensor* sensor, const unsigned char* odometry_config_buf, unsigned int blob_size, rs2_error** error);
554 
561 int rs2_send_wheel_odometry(const rs2_sensor* sensor, char wo_sensor_id, unsigned int frame_num,
562  const rs2_vector translational_velocity, rs2_error** error);
563 
571 void rs2_set_intrinsics(const rs2_sensor* sensor, const rs2_stream_profile* profile , const rs2_intrinsics* intrinsics, rs2_error** error);
572 
582 void rs2_set_extrinsics(const rs2_sensor* from_sensor, const rs2_stream_profile* from_profile, rs2_sensor* to_sensor, const rs2_stream_profile* to_profile, const rs2_extrinsics* extrinsics, rs2_error** error);
583 
591 void rs2_set_motion_device_intrinsics(const rs2_sensor* sensor, const rs2_stream_profile* profile, const rs2_motion_device_intrinsic* intrinsics, rs2_error** error);
592 
593 
594 #ifdef __cplusplus
595 }
596 #endif
597 #endif // LIBREALSENSE_RS2_SENSOR_H
Definition: rs_sensor.h:33
Definition: rs_sensor.h:75
struct rs2_processing_block_list rs2_processing_block_list
Definition: rs_types.h:227
void rs2_register_extrinsics(const rs2_stream_profile *from, const rs2_stream_profile *to, rs2_extrinsics extrin, rs2_error **error)
int rs2_get_sensors_count(const rs2_sensor_list *info_list, rs2_error **error)
rs2_camera_info
Read-only strings that can be queried from the device. Not all information attributes are available o...
Definition: rs_sensor.h:22
Definition: rs_types.hpp:25
const char * rs2_format_to_string(rs2_format format)
Definition: rs_sensor.h:66
struct rs2_raw_data_buffer rs2_raw_data_buffer
Definition: rs_types.h:219
Definition: rs_sensor.h:79
float rs2_get_depth_scale(rs2_sensor *sensor, rs2_error **error)
Definition: rs_sensor.h:27
Definition: rs_sensor.h:28
Definition: rs_types.hpp:39
struct rs2_frame_queue rs2_frame_queue
Definition: rs_types.h:221
void rs2_get_video_stream_resolution(const rs2_stream_profile *mode, int *width, int *height, rs2_error **error)
void rs2_set_intrinsics(const rs2_sensor *sensor, const rs2_stream_profile *profile, const rs2_intrinsics *intrinsics, rs2_error **error)
rs2_sensor * rs2_create_sensor(const rs2_sensor_list *list, int index, rs2_error **error)
Definition: rs_sensor.h:24
int rs2_get_static_node(const rs2_sensor *sensor, const char *guid, rs2_vector *pos, rs2_quaternion *orient, rs2_error **error)
float translation[3]
Definition: rs_sensor.h:97
Definition: rs_sensor.h:30
void rs2_get_extrinsics(const rs2_stream_profile *from, const rs2_stream_profile *to, rs2_extrinsics *extrin, rs2_error **error)
rs2_device * rs2_create_device_from_sensor(const rs2_sensor *sensor, rs2_error **error)
Definition: rs_sensor.h:78
void rs2_set_region_of_interest(const rs2_sensor *sensor, int min_x, int min_y, int max_x, int max_y, rs2_error **error)
sets the active region of interest to be used by auto-exposure algorithm
Definition: rs_sensor.h:31
Definition: rs_sensor.h:61
Definition: rs_sensor.h:47
Definition: rs_sensor.h:81
int rs2_import_localization_map(const rs2_sensor *sensor, const unsigned char *lmap_blob, unsigned int blob_size, rs2_error **error)
Definition: rs_sensor.h:86
struct rs2_sensor_list rs2_sensor_list
Definition: rs_types.h:240
Definition: rs_sensor.h:51
void rs2_stop(const rs2_sensor *sensor, rs2_error **error)
Definition: rs_sensor.h:64
void rs2_start_queue(const rs2_sensor *sensor, rs2_frame_queue *queue, rs2_error **error)
int rs2_stream_profile_is(const rs2_stream_profile *mode, rs2_extension type, rs2_error **error)
const char * rs2_get_notification_serialized_data(rs2_notification *notification, rs2_error **error)
Definition: rs_sensor.h:23
Definition: rs_sensor.h:50
rs2_log_severity rs2_get_notification_severity(rs2_notification *notification, rs2_error **error)
Definition: rs_sensor.h:34
Definition: rs_sensor.h:62
Definition: rs_sensor.h:48
rs2_stream_profile * rs2_clone_stream_profile(const rs2_stream_profile *mode, rs2_stream stream, int index, rs2_format format, rs2_error **error)
struct rs2_sensor rs2_sensor
Definition: rs_types.h:241
float rotation[9]
Definition: rs_sensor.h:96
Definition: rs_sensor.h:45
void rs2_open(rs2_sensor *device, const rs2_stream_profile *profile, rs2_error **error)
void rs2_set_stream_profile_data(rs2_stream_profile *mode, rs2_stream stream, int index, rs2_format format, rs2_error **error)
Definition: rs_sensor.h:65
Quaternion used to represent rotation.
Definition: rs_types.h:103
Definition: rs_sensor.h:63
void rs2_get_stream_profile_data(const rs2_stream_profile *mode, rs2_stream *stream, rs2_format *format, int *index, int *unique_id, int *framerate, rs2_error **error)
Definition: rs_sensor.h:82
struct rs2_notification rs2_notification
Definition: rs_types.h:245
int rs2_is_stream_profile_default(const rs2_stream_profile *mode, rs2_error **error)
Exposes RealSense structs.
void rs2_start(const rs2_sensor *sensor, rs2_frame_callback_ptr on_frame, void *user, rs2_error **error)
void rs2_set_notifications_callback(const rs2_sensor *sensor, rs2_notification_callback_ptr on_notification, void *user, rs2_error **error)
float rs2_get_stereo_baseline(rs2_sensor *sensor, rs2_error **error)
int rs2_get_recommended_processing_blocks_count(const rs2_processing_block_list *list, rs2_error **error)
void rs2_delete_sensor(rs2_sensor *sensor)
void rs2_get_region_of_interest(const rs2_sensor *sensor, int *min_x, int *min_y, int *max_x, int *max_y, rs2_error **error)
gets the active region of interest to be used by auto-exposure algorithm
Definition: rs_sensor.h:53
rs2_time_t rs2_get_notification_timestamp(rs2_notification *notification, rs2_error **error)
Definition: rs_sensor.h:32
void rs2_set_extrinsics(const rs2_sensor *from_sensor, const rs2_stream_profile *from_profile, rs2_sensor *to_sensor, const rs2_stream_profile *to_profile, const rs2_extrinsics *extrinsics, rs2_error **error)
int rs2_remove_static_node(const rs2_sensor *sensor, const char *guid, rs2_error **error)
Definition: rs_sensor.h:52
Definition: rs_sensor.h:80
void rs2_delete_stream_profile(rs2_stream_profile *mode)
struct rs2_stream_profile_list rs2_stream_profile_list
Definition: rs_types.h:226
const rs2_stream_profile * rs2_get_stream_profile(const rs2_stream_profile_list *list, int index, rs2_error **error)
Definition: rs_sensor.h:87
void rs2_set_notifications_callback_cpp(const rs2_sensor *sensor, rs2_notifications_callback *callback, rs2_error **error)
Definition: rs_sensor.h:85
struct rs2_stream_profile rs2_stream_profile
Definition: rs_types.h:228
Definition: rs_sensor.h:60
rs2_format
A stream's format identifies how binary data is encoded within a frame.
Definition: rs_sensor.h:58
int rs2_supports_sensor_info(const rs2_sensor *sensor, rs2_camera_info info, rs2_error **error)
Definition: rs_sensor.h:25
void rs2_delete_recommended_processing_blocks(rs2_processing_block_list *list)
Definition: rs_sensor.h:74
Definition: rs_sensor.h:36
Definition: rs_sensor.h:89
Definition: rs_sensor.h:76
Definition: rs_sensor.h:44
rs2_stream
Streams are different types of data provided by RealSense devices.
Definition: rs_sensor.h:41
void rs2_set_motion_device_intrinsics(const rs2_sensor *sensor, const rs2_stream_profile *profile, const rs2_motion_device_intrinsic *intrinsics, rs2_error **error)
void rs2_get_video_stream_intrinsics(const rs2_stream_profile *mode, rs2_intrinsics *intrinsics, rs2_error **error)
Definition: rs_sensor.h:46
Definition: rs_sensor.h:49
Definition: rs_sensor.h:72
Cross-stream extrinsics: encodes the topology describing how the different devices are oriented.
Definition: rs_sensor.h:94
const char * rs2_camera_info_to_string(rs2_camera_info info)
int rs2_is_sensor_extendable_to(const rs2_sensor *sensor, rs2_extension extension, rs2_error **error)
3D vector in Euclidean coordinate space
Definition: rs_types.h:97
struct rs2_processing_block rs2_processing_block
Definition: rs_types.h:234
const char * rs2_stream_to_string(rs2_stream stream)
rs2_extension
Specifies advanced interfaces (capabilities) objects may implement.
Definition: rs_types.h:134
rs2_notification_category
Category of the librealsense notification.
Definition: rs_types.h:17
Definition: rs_sensor.h:43
void(* rs2_notification_callback_ptr)(rs2_notification *, void *)
Definition: rs_types.h:248
void rs2_delete_stream_profiles_list(rs2_stream_profile_list *list)
void rs2_close(const rs2_sensor *sensor, rs2_error **error)
struct rs2_device rs2_device
Definition: rs_types.h:216
rs2_stream_profile_list * rs2_get_stream_profiles(rs2_sensor *device, rs2_error **error)
Video stream intrinsics.
Definition: rs_types.h:58
rs2_stream_profile * rs2_clone_video_stream_profile(const rs2_stream_profile *mode, rs2_stream stream, int index, rs2_format format, int width, int height, const rs2_intrinsics *intr, rs2_error **error)
void rs2_open_multiple(rs2_sensor *device, const rs2_stream_profile **profiles, int count, rs2_error **error)
void rs2_start_cpp(const rs2_sensor *sensor, rs2_frame_callback *callback, rs2_error **error)
Definition: rs_sensor.h:68
rs2_notification_category rs2_get_notification_category(rs2_notification *notification, rs2_error **error)
rs2_processing_block * rs2_get_processing_block(const rs2_processing_block_list *list, int index, rs2_error **error)
Motion device intrinsics: scale, bias, and variances.
Definition: rs_types.h:71
struct rs2_extrinsics rs2_extrinsics
Cross-stream extrinsics: encodes the topology describing how the different devices are oriented.
void rs2_delete_sensor_list(rs2_sensor_list *info_list)
Definition: rs_sensor.h:35
int rs2_set_static_node(const rs2_sensor *sensor, const char *guid, const rs2_vector pos, const rs2_quaternion orient, rs2_error **error)
void(* rs2_frame_callback_ptr)(rs2_frame *, void *)
Definition: rs_types.h:250
Definition: rs_sensor.h:77
const rs2_raw_data_buffer * rs2_export_localization_map(const rs2_sensor *sensor, rs2_error **error)
float rs2_depth_stereo_frame_get_baseline(const rs2_frame *frame_ref, rs2_error **error)
const char * rs2_get_sensor_info(const rs2_sensor *sensor, rs2_camera_info info, rs2_error **error)
const char * rs2_get_notification_description(rs2_notification *notification, rs2_error **error)
int rs2_get_stream_profiles_count(const rs2_stream_profile_list *list, rs2_error **error)
struct rs2_error rs2_error
Definition: rs_types.h:217
double rs2_time_t
Definition: rs_types.h:254
int rs2_load_wheel_odometry_config(const rs2_sensor *sensor, const unsigned char *odometry_config_buf, unsigned int blob_size, rs2_error **error)
Definition: rs_sensor.h:88
rs2_log_severity
Severity of the librealsense logger.
Definition: rs_types.h:121
Definition: rs_sensor.h:70
rs2_processing_block_list * rs2_get_recommended_processing_blocks(rs2_sensor *sensor, rs2_error **error)
int rs2_send_wheel_odometry(const rs2_sensor *sensor, char wo_sensor_id, unsigned int frame_num, const rs2_vector translational_velocity, rs2_error **error)
void rs2_get_motion_intrinsics(const rs2_stream_profile *mode, rs2_motion_device_intrinsic *intrinsics, rs2_error **error)
Definition: rs_sensor.h:73
Definition: rs_sensor.h:29
Definition: rs_sensor.h:84
struct rs2_frame rs2_frame
Definition: rs_types.h:220
Definition: rs_sensor.h:67
Definition: rs_sensor.h:69
Definition: rs_sensor.h:83
Definition: rs_sensor.h:71