Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Classes | Enumerations | Functions | Variables
rsimpl::ds Namespace Reference

Classes

struct  ae_params
 
struct  dc_params
 
struct  dinghy
 
struct  discovery
 
struct  disp_mode
 
struct  ds_calibration
 
class  ds_device
 
struct  ds_head_content
 The struct is aligned with the data layout in device. More...
 
struct  ds_info
 
struct  range
 
struct  rate_value
 
struct  temperature
 
class  time_pad
 

Enumerations

enum  subdevices { SUB_DEVICE_INFRARED = 0, SUB_DEVICE_DEPTH = 1, SUB_DEVICE_COLOR = 2, SUB_DEVICE_FISHEYE = 3 }
 
enum  ds_lens_type : uint32_t {
  DS_LENS_UNKNOWN = 0, DS_LENS_DSL103 = 1, DS_LENS_DSL821C = 2, DS_LENS_DSL202A = 3,
  DS_LENS_DSL203 = 4, DS_LENS_PENTAX2514 = 5, DS_LENS_DSL924A = 6, DS_LENS_AZW58 = 7,
  DS_LENS_Largan9386 = 8, DS_LENS_DS6100 = 9, DS_LENS_DS6177 = 10, DS_LENS_DS6237 = 11,
  DS_LENS_DS6233 = 12, DS_LENS_DS917 = 13, DS_LENS_AEOT_1LS0901L = 14, DS_LENS_COUNT = 15
}
 
enum  ds_lens_coating_type : uint32_t {
  DS_LENS_COATING_UNKNOWN = 0, DS_LENS_COATING_IR_CUT = 1, DS_LENS_COATING_ALL_PASS = 2, DS_LENS_COATING_IR_PASS = 3,
  DS_LENS_COATING_IR_PASS_859_43 = 4, DS_LENS_COATING_COUNT = 5
}
 
enum  ds_emitter_type : uint32_t {
  DS_EMITTER_NONE = 0, DS_EMITTER_LD2 = 1, DS_EMITTER_LD3 = 2, DS_EMITTER_LD4_1 = 3,
  DS_EMITTER_COUNT = 4
}
 
enum  ds_oem_id : uint32_t { DS_OEM_NONE = 0 }
 
enum  ds_prq_type : uint8_t { DS_PRQ_READY = 1 }
 
enum  control {
  control::command_response = 1, control::fisheye_xu_strobe = 1, control::iffley = 2, control::fisheye_xu_ext_trig = 2,
  control::stream_intent = 3, control::fisheye_exposure = 3, control::depth_units = 4, control::min_max = 5,
  control::disparity = 6, control::rectification = 7, control::emitter = 8, control::temperature = 9,
  control::depth_params = 10, control::last_error = 12, control::embedded_count = 13, control::lr_exposure = 14,
  control::lr_autoexposure_parameters = 15, control::sw_reset = 16, control::lr_gain = 17, control::lr_exposure_mode = 18,
  control::disparity_shift = 19, control::status = 20, control::lr_exposure_discovery = 21, control::lr_gain_discovery = 22,
  control::hw_timestamp = 23
}
 

Functions

std::ostream & operator<< (std::ostream &out, ds_lens_type type)
 
std::ostream & operator<< (std::ostream &out, ds_lens_coating_type type)
 
std::ostream & operator<< (std::ostream &out, ds_emitter_type type)
 
std::ostream & operator<< (std::ostream &out, ds_oem_id type)
 
std::ostream & operator<< (std::ostream &out, ds_prq_type type)
 
std::string time_to_string (double val)
 
ds_info read_camera_info (uvc::device &device)
 
std::string read_firmware_version (uvc::device &device)
 
std::string read_isp_firmware_version (uvc::device &device)
 
void xu_read (const uvc::device &device, uvc::extension_unit xu, control xu_ctrl, void *buffer, uint32_t length)
 
void xu_write (uvc::device &device, uvc::extension_unit xu, control xu_ctrl, void *buffer, uint32_t length)
 
template<class T >
xu_read (const uvc::device &dev, uvc::extension_unit xu, control ctrl)
 
template<class T >
void xu_write (uvc::device &dev, uvc::extension_unit xu, control ctrl, const T &value)
 
void set_stream_intent (uvc::device &device, uint8_t &intent)
 
void get_stream_status (const uvc::device &device, uint32_t &status)
 
void force_firmware_reset (uvc::device &device)
 
bool get_emitter_state (const uvc::device &device, bool is_streaming, bool is_depth_enabled)
 
void set_emitter_state (uvc::device &device, bool state)
 
void get_register_value (uvc::device &device, uint32_t reg, uint32_t &value)
 
void set_register_value (uvc::device &device, uint32_t reg, uint32_t value)
 
uint32_t get_depth_units (const uvc::device &device)
 
range get_min_max_depth (const uvc::device &device)
 
disp_mode get_disparity_mode (const uvc::device &device)
 
temperature get_temperature (const uvc::device &device)
 
dc_params get_depth_params (const uvc::device &device)
 
uint8_t get_last_error (const uvc::device &device)
 
rate_value get_lr_exposure (const uvc::device &device)
 
ae_params get_lr_auto_exposure_params (const uvc::device &device, std::vector< supported_option > ae_vec)
 
rate_value get_lr_gain (const uvc::device &device)
 
uint8_t get_lr_exposure_mode (const uvc::device &device)
 
uint32_t get_disparity_shift (const uvc::device &device)
 
discovery get_lr_exposure_discovery (const uvc::device &device)
 
discovery get_lr_gain_discovery (const uvc::device &device)
 
void set_depth_units (uvc::device &device, uint32_t units)
 
void set_min_max_depth (uvc::device &device, range min_max)
 
void set_disparity_mode (uvc::device &device, disp_mode mode)
 
void set_temperature (uvc::device &device, temperature temp)
 
void set_depth_params (uvc::device &device, dc_params params)
 
void set_lr_auto_exposure_params (uvc::device &device, ae_params params)
 
void set_lr_exposure_mode (uvc::device &device, uint8_t mode)
 
void set_disparity_shift (uvc::device &device, uint32_t shift)
 
void set_lr_exposure_discovery (uvc::device &device, discovery disc)
 
void set_lr_gain_discovery (uvc::device &device, discovery disc)
 
void set_lr_exposure (uvc::device &device, rate_value exposure)
 
void set_lr_gain (uvc::device &device, rate_value gain)
 

Variables

const uvc::extension_unit lr_xu = {0, 2, 1, {0x18682d34, 0xdd2c, 0x4073, {0xad, 0x23, 0x72, 0x14, 0x73, 0x9a, 0x07, 0x4c}}}
 
const int STATUS_BIT_Z_STREAMING = 1 << 0
 
const int STATUS_BIT_LR_STREAMING = 1 << 1
 
const int STATUS_BIT_WEB_STREAMING = 1 << 2
 

Enumeration Type Documentation

◆ control

enum rsimpl::ds::control
strong
Enumerator
command_response 
fisheye_xu_strobe 
iffley 
fisheye_xu_ext_trig 
stream_intent 
fisheye_exposure 
depth_units 
min_max 
disparity 
rectification 
emitter 
temperature 
depth_params 
last_error 
embedded_count 
lr_exposure 
lr_autoexposure_parameters 
sw_reset 
lr_gain 
lr_exposure_mode 
disparity_shift 
status 
lr_exposure_discovery 
lr_gain_discovery 
hw_timestamp 

◆ ds_emitter_type

enum rsimpl::ds::ds_emitter_type : uint32_t
Enumerator
DS_EMITTER_NONE 
DS_EMITTER_LD2 

Laser Driver 2, NO PWM Controls.

DS_EMITTER_LD3 

Laser Driver 3.

DS_EMITTER_LD4_1 

Laser Driver 4.1.

DS_EMITTER_COUNT 

Just count.

◆ ds_lens_coating_type

Enumerator
DS_LENS_COATING_UNKNOWN 
DS_LENS_COATING_IR_CUT 

IR coating DS4: Innowave 670 cut off.

DS_LENS_COATING_ALL_PASS 

No IR coating.

DS_LENS_COATING_IR_PASS 

Visible-light block / IR pass: center 860, width 25nm.

DS_LENS_COATING_IR_PASS_859_43 

Visible-light block / IR pass center 859, width 43nm.

DS_LENS_COATING_COUNT 

◆ ds_lens_type

enum rsimpl::ds::ds_lens_type : uint32_t
Enumerator
DS_LENS_UNKNOWN 

Lens either unknown or not needing special treatment.

DS_LENS_DSL103 

Sunex DSL103: Internal standard.

DS_LENS_DSL821C 

Sunex DSL 821C.

DS_LENS_DSL202A 

Sunex DSL 202A.

DS_LENS_DSL203 

Sunex DSL 203.

DS_LENS_PENTAX2514 

Pentax cmount lens 25mm.

DS_LENS_DSL924A 

Sunex DSL 924a.

DS_LENS_AZW58 

58 degree lenses on the AZureWave boards (DS-526)

DS_LENS_Largan9386 

50 HFOV 38 VFOV (60DFOV): CTM2/6 Module L&R

DS_LENS_DS6100 

Newmax 67.8 x 41.4 degs in 1080p.

DS_LENS_DS6177 

Newmax 71.7 x 44.2 degs in 1080p.

DS_LENS_DS6237 

Newmax 58.9 x 45.9 degs in VGA.

DS_LENS_DS6233 

IR lens.

DS_LENS_DS917 

RGB lens.

DS_LENS_AEOT_1LS0901L 
DS_LENS_COUNT 

AEOT lens.

Just count

◆ ds_oem_id

enum rsimpl::ds::ds_oem_id : uint32_t
Enumerator
DS_OEM_NONE 

◆ ds_prq_type

enum rsimpl::ds::ds_prq_type : uint8_t
Enumerator
DS_PRQ_READY 

◆ subdevices

Enumerator
SUB_DEVICE_INFRARED 
SUB_DEVICE_DEPTH 
SUB_DEVICE_COLOR 
SUB_DEVICE_FISHEYE 

Function Documentation

◆ force_firmware_reset()

void rsimpl::ds::force_firmware_reset ( uvc::device &  device)

◆ get_depth_params()

dc_params rsimpl::ds::get_depth_params ( const uvc::device &  device)
inline

◆ get_depth_units()

uint32_t rsimpl::ds::get_depth_units ( const uvc::device &  device)
inline

◆ get_disparity_mode()

disp_mode rsimpl::ds::get_disparity_mode ( const uvc::device &  device)
inline

◆ get_disparity_shift()

uint32_t rsimpl::ds::get_disparity_shift ( const uvc::device &  device)
inline

◆ get_emitter_state()

bool rsimpl::ds::get_emitter_state ( const uvc::device &  device,
bool  is_streaming,
bool  is_depth_enabled 
)

◆ get_last_error()

uint8_t rsimpl::ds::get_last_error ( const uvc::device &  device)
inline

◆ get_lr_auto_exposure_params()

ae_params rsimpl::ds::get_lr_auto_exposure_params ( const uvc::device &  device,
std::vector< supported_option ae_vec 
)
inline

◆ get_lr_exposure()

rate_value rsimpl::ds::get_lr_exposure ( const uvc::device &  device)
inline

◆ get_lr_exposure_discovery()

discovery rsimpl::ds::get_lr_exposure_discovery ( const uvc::device &  device)
inline

◆ get_lr_exposure_mode()

uint8_t rsimpl::ds::get_lr_exposure_mode ( const uvc::device &  device)
inline

◆ get_lr_gain()

rate_value rsimpl::ds::get_lr_gain ( const uvc::device &  device)
inline

◆ get_lr_gain_discovery()

discovery rsimpl::ds::get_lr_gain_discovery ( const uvc::device &  device)
inline

◆ get_min_max_depth()

range rsimpl::ds::get_min_max_depth ( const uvc::device &  device)
inline

◆ get_register_value()

void rsimpl::ds::get_register_value ( uvc::device &  device,
uint32_t  reg,
uint32_t &  value 
)

◆ get_stream_status()

void rsimpl::ds::get_stream_status ( const uvc::device &  device,
uint32_t &  status 
)

◆ get_temperature()

temperature rsimpl::ds::get_temperature ( const uvc::device &  device)
inline

◆ operator<<() [1/5]

std::ostream& rsimpl::ds::operator<< ( std::ostream &  out,
ds_emitter_type  type 
)
inline

◆ operator<<() [2/5]

std::ostream& rsimpl::ds::operator<< ( std::ostream &  out,
ds_lens_coating_type  type 
)
inline

◆ operator<<() [3/5]

std::ostream& rsimpl::ds::operator<< ( std::ostream &  out,
ds_lens_type  type 
)
inline

◆ operator<<() [4/5]

std::ostream& rsimpl::ds::operator<< ( std::ostream &  out,
ds_oem_id  type 
)
inline

◆ operator<<() [5/5]

std::ostream& rsimpl::ds::operator<< ( std::ostream &  out,
ds_prq_type  type 
)
inline

◆ read_camera_info()

ds_info rsimpl::ds::read_camera_info ( uvc::device &  device)

◆ read_firmware_version()

std::string rsimpl::ds::read_firmware_version ( uvc::device &  device)

◆ read_isp_firmware_version()

std::string rsimpl::ds::read_isp_firmware_version ( uvc::device &  device)

◆ set_depth_params()

void rsimpl::ds::set_depth_params ( uvc::device &  device,
dc_params  params 
)
inline

◆ set_depth_units()

void rsimpl::ds::set_depth_units ( uvc::device &  device,
uint32_t  units 
)
inline

◆ set_disparity_mode()

void rsimpl::ds::set_disparity_mode ( uvc::device &  device,
disp_mode  mode 
)
inline

◆ set_disparity_shift()

void rsimpl::ds::set_disparity_shift ( uvc::device &  device,
uint32_t  shift 
)
inline

◆ set_emitter_state()

void rsimpl::ds::set_emitter_state ( uvc::device &  device,
bool  state 
)

◆ set_lr_auto_exposure_params()

void rsimpl::ds::set_lr_auto_exposure_params ( uvc::device &  device,
ae_params  params 
)
inline

◆ set_lr_exposure()

void rsimpl::ds::set_lr_exposure ( uvc::device &  device,
rate_value  exposure 
)
inline

◆ set_lr_exposure_discovery()

void rsimpl::ds::set_lr_exposure_discovery ( uvc::device &  device,
discovery  disc 
)
inline

◆ set_lr_exposure_mode()

void rsimpl::ds::set_lr_exposure_mode ( uvc::device &  device,
uint8_t  mode 
)
inline

◆ set_lr_gain()

void rsimpl::ds::set_lr_gain ( uvc::device &  device,
rate_value  gain 
)
inline

◆ set_lr_gain_discovery()

void rsimpl::ds::set_lr_gain_discovery ( uvc::device &  device,
discovery  disc 
)
inline

◆ set_min_max_depth()

void rsimpl::ds::set_min_max_depth ( uvc::device &  device,
range  min_max 
)
inline

◆ set_register_value()

void rsimpl::ds::set_register_value ( uvc::device &  device,
uint32_t  reg,
uint32_t  value 
)

◆ set_stream_intent()

void rsimpl::ds::set_stream_intent ( uvc::device &  device,
uint8_t &  intent 
)

◆ set_temperature()

void rsimpl::ds::set_temperature ( uvc::device &  device,
temperature  temp 
)
inline

◆ time_to_string()

std::string rsimpl::ds::time_to_string ( double  val)
inline

◆ xu_read() [1/2]

template<class T >
T rsimpl::ds::xu_read ( const uvc::device &  dev,
uvc::extension_unit  xu,
control  ctrl 
)

◆ xu_read() [2/2]

void rsimpl::ds::xu_read ( const uvc::device &  device,
uvc::extension_unit  xu,
control  xu_ctrl,
void *  buffer,
uint32_t  length 
)

◆ xu_write() [1/2]

template<class T >
void rsimpl::ds::xu_write ( uvc::device &  dev,
uvc::extension_unit  xu,
control  ctrl,
const T &  value 
)

◆ xu_write() [2/2]

void rsimpl::ds::xu_write ( uvc::device &  device,
uvc::extension_unit  xu,
control  xu_ctrl,
void *  buffer,
uint32_t  length 
)

Variable Documentation

◆ lr_xu

const uvc::extension_unit rsimpl::ds::lr_xu = {0, 2, 1, {0x18682d34, 0xdd2c, 0x4073, {0xad, 0x23, 0x72, 0x14, 0x73, 0x9a, 0x07, 0x4c}}}

◆ STATUS_BIT_LR_STREAMING

const int rsimpl::ds::STATUS_BIT_LR_STREAMING = 1 << 1

◆ STATUS_BIT_WEB_STREAMING

const int rsimpl::ds::STATUS_BIT_WEB_STREAMING = 1 << 2

◆ STATUS_BIT_Z_STREAMING

const int rsimpl::ds::STATUS_BIT_Z_STREAMING = 1 << 0