depthai 0.1.3

Experimental Rust bindings and idiomatic wrapper for Luxonis DepthAI-Core v3.
Documentation
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
use std::sync::Arc;
use std::time::Duration;

use autocxx::c_int;
use depthai_sys::{depthai, DaiCameraNode, DaiDataQueue, DaiImgFrame, DaiNode};

pub use crate::common::{CameraBoardSocket, CameraImageOrientation, CameraSensorType, ImageFrameType, ResizeMode};
use crate::error::{Result, clear_error_flag, last_error, take_error_if_any};
use crate::pipeline::device_node::CreateInPipelineWith;
use crate::pipeline::{Pipeline, PipelineInner};
use crate::output::Output as NodeOutput;

#[crate::native_node_wrapper(
    native = "dai::node::Camera",
    inputs(inputControl, mockIsp),
    outputs(raw)
)]
pub struct CameraNode {
    node: crate::pipeline::Node,
}

/// Alias for camera output.
///
/// We reuse the common type `crate::output::Output` for consistency (link/queue).
pub type CameraOutput = NodeOutput;

pub struct OutputQueue {
    handle: DaiDataQueue,
}

pub struct ImageFrame {
    handle: DaiImgFrame,
}

#[derive(Debug, Clone, Default)]
pub struct CameraBuildConfig {
    pub board_socket: CameraBoardSocket,
    pub sensor_resolution: Option<(u32, u32)>,
    pub sensor_fps: Option<f32>,
}

#[derive(Debug, Clone)]
pub struct CameraFullResolutionConfig {
    pub frame_type: Option<ImageFrameType>,
    pub fps: Option<f32>,
    pub use_highest_resolution: bool,
}

impl Default for CameraFullResolutionConfig {
    fn default() -> Self {
        Self {
            frame_type: None,
            fps: None,
            use_highest_resolution: false,
        }
    }
}

#[derive(Debug, Clone)]
pub struct CameraOutputConfig {
    pub size: (u32, u32),
    pub frame_type: Option<ImageFrameType>,
    pub resize_mode: ResizeMode,
    pub fps: Option<f32>,
    pub enable_undistortion: Option<bool>,
}

impl Default for CameraOutputConfig {
    fn default() -> Self {
        Self {
            size: (640, 400),
            frame_type: None,
            resize_mode: ResizeMode::Crop,
            fps: None,
            enable_undistortion: None,
        }
    }
}

impl CameraOutputConfig {
    pub fn new(size: (u32, u32)) -> Self {
        Self {
            size,
            ..Default::default()
        }
    }
}

impl CameraNode {
    pub(crate) fn from_handle(pipeline: Arc<PipelineInner>, handle: DaiCameraNode) -> Self {
        Self { 
            node: crate::pipeline::Node::from_handle(pipeline, handle as DaiNode)
        }
    }

    pub fn request_output(&self, config: CameraOutputConfig) -> Result<CameraOutput> {
        clear_error_flag();
        let fmt = config.frame_type.map(|t| t as i32).unwrap_or(-1);
        let resize = config.resize_mode as i32;
        let fps = config.fps.unwrap_or(-1.0);
        let undist = config
            .enable_undistortion
            .map(|v| if v { 1 } else { 0 })
            .unwrap_or(-1);
        let handle = unsafe {
            depthai::dai_camera_request_output(
                self.node.handle() as DaiCameraNode,
                c_int(config.size.0 as i32),
                c_int(config.size.1 as i32),
                c_int(fmt),
                c_int(resize),
                fps,
                c_int(undist),
            )
        };
        if handle.is_null() {
            Err(last_error("failed to request camera output"))
        } else {
            Ok(NodeOutput::from_handle(std::sync::Arc::clone(&self.node.pipeline), handle))
        }
    }

    pub fn request_full_resolution_output(&self) -> Result<CameraOutput> {
        self.request_full_resolution_output_with(CameraFullResolutionConfig::default())
    }

    pub fn request_full_resolution_output_with(&self, config: CameraFullResolutionConfig) -> Result<CameraOutput> {
        clear_error_flag();
        let fmt = config.frame_type.map(|t| t as i32).unwrap_or(-1);
        let fps = config.fps.unwrap_or(-1.0);
        let handle = unsafe {
            depthai::dai_camera_request_full_resolution_output_ex(
                self.node.handle() as DaiCameraNode,
                c_int(fmt),
                fps,
                config.use_highest_resolution,
            )
        };
        if handle.is_null() {
            Err(last_error("failed to request full resolution output"))
        } else {
            Ok(NodeOutput::from_handle(std::sync::Arc::clone(&self.node.pipeline), handle))
        }
    }

    /// Configure (build) the camera node.
    ///
    /// Useful when the node was created via `Pipeline::create::<CameraNode>()` (string-based)
    /// as opposed to `Pipeline::create_camera(...)` which calls `build()` immediately.
    pub fn build(&self, config: CameraBuildConfig) -> Result<()> {
        clear_error_flag();
        let (w, h) = config
            .sensor_resolution
            .map(|(w, h)| (w as i32, h as i32))
            .unwrap_or((-1, -1));
        let fps = config.sensor_fps.unwrap_or(-1.0);
        let ok = unsafe {
            depthai::dai_camera_build(
                self.node.handle() as DaiCameraNode,
                c_int(config.board_socket.as_raw()),
                c_int(w),
                c_int(h),
                fps,
            )
        };
        if ok {
            Ok(())
        } else {
            Err(last_error("failed to build camera"))
        }
    }

    pub fn board_socket(&self) -> Result<CameraBoardSocket> {
        clear_error_flag();
        let raw = unsafe { depthai::dai_camera_get_board_socket(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get camera board socket") {
            return Err(err);
        }
        Ok(CameraBoardSocket::from_raw(raw.into()))
    }

    pub fn max_width(&self) -> Result<u32> {
        clear_error_flag();
        let w = unsafe { depthai::dai_camera_get_max_width(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get camera max width") {
            return Err(err);
        }
        Ok(w as u32)
    }

    pub fn max_height(&self) -> Result<u32> {
        clear_error_flag();
        let h = unsafe { depthai::dai_camera_get_max_height(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get camera max height") {
            return Err(err);
        }
        Ok(h as u32)
    }

    pub fn set_sensor_type(&self, sensor_type: CameraSensorType) -> Result<()> {
        clear_error_flag();
        unsafe {
            depthai::dai_camera_set_sensor_type(
                self.node.handle() as DaiCameraNode,
                c_int(sensor_type.as_raw()),
            )
        };
        if let Some(err) = take_error_if_any("failed to set camera sensor type") {
            return Err(err);
        }
        Ok(())
    }

    pub fn sensor_type(&self) -> Result<CameraSensorType> {
        clear_error_flag();
        let raw = unsafe { depthai::dai_camera_get_sensor_type(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get camera sensor type") {
            return Err(err);
        }
        Ok(CameraSensorType::from_raw(raw.into()))
    }

    pub fn set_raw_num_frames_pool(&self, num: i32) -> Result<()> {
        clear_error_flag();
        unsafe { depthai::dai_camera_set_raw_num_frames_pool(self.node.handle() as DaiCameraNode, c_int(num)) };
        if let Some(err) = take_error_if_any("failed to set raw num frames pool") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_max_size_pool_raw(&self, size: i32) -> Result<()> {
        clear_error_flag();
        unsafe { depthai::dai_camera_set_max_size_pool_raw(self.node.handle() as DaiCameraNode, c_int(size)) };
        if let Some(err) = take_error_if_any("failed to set raw max size pool") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_isp_num_frames_pool(&self, num: i32) -> Result<()> {
        clear_error_flag();
        unsafe { depthai::dai_camera_set_isp_num_frames_pool(self.node.handle() as DaiCameraNode, c_int(num)) };
        if let Some(err) = take_error_if_any("failed to set isp num frames pool") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_max_size_pool_isp(&self, size: i32) -> Result<()> {
        clear_error_flag();
        unsafe { depthai::dai_camera_set_max_size_pool_isp(self.node.handle() as DaiCameraNode, c_int(size)) };
        if let Some(err) = take_error_if_any("failed to set isp max size pool") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_num_frames_pools(&self, raw: i32, isp: i32, outputs: i32) -> Result<()> {
        clear_error_flag();
        unsafe {
            depthai::dai_camera_set_num_frames_pools(
                self.node.handle() as DaiCameraNode,
                c_int(raw),
                c_int(isp),
                c_int(outputs),
            )
        };
        if let Some(err) = take_error_if_any("failed to set num frames pools") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_max_size_pools(&self, raw: i32, isp: i32, outputs: i32) -> Result<()> {
        clear_error_flag();
        unsafe {
            depthai::dai_camera_set_max_size_pools(
                self.node.handle() as DaiCameraNode,
                c_int(raw),
                c_int(isp),
                c_int(outputs),
            )
        };
        if let Some(err) = take_error_if_any("failed to set max size pools") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_outputs_num_frames_pool(&self, num: i32) -> Result<()> {
        clear_error_flag();
        unsafe { depthai::dai_camera_set_outputs_num_frames_pool(self.node.handle() as DaiCameraNode, c_int(num)) };
        if let Some(err) = take_error_if_any("failed to set outputs num frames pool") {
            return Err(err);
        }
        Ok(())
    }

    pub fn set_outputs_max_size_pool(&self, size: i32) -> Result<()> {
        clear_error_flag();
        unsafe { depthai::dai_camera_set_outputs_max_size_pool(self.node.handle() as DaiCameraNode, c_int(size)) };
        if let Some(err) = take_error_if_any("failed to set outputs max size pool") {
            return Err(err);
        }
        Ok(())
    }

    // -----------------------------------------------------------------------
    // v3.4.0+ additions
    // -----------------------------------------------------------------------

    /// Request an output at the ISP (Image Signal Processor) resolution.
    ///
    /// Unlike `request_output`, the fps does not participate in sensor-fps voting.
    /// Pass `fps = None` to let the pipeline select the rate automatically.
    ///
    /// Requires depthai-core **v3.4.0+**.
    pub fn request_isp_output(&self, fps: Option<f32>) -> Result<CameraOutput> {
        clear_error_flag();
        let fps_val = fps.unwrap_or(-1.0);
        let handle = unsafe {
            depthai::dai_camera_request_isp_output(
                self.node.handle() as DaiCameraNode,
                fps_val,
            )
        };
        if handle.is_null() {
            Err(last_error("failed to request ISP output"))
        } else {
            Ok(NodeOutput::from_handle(std::sync::Arc::clone(&self.node.pipeline), handle))
        }
    }

    /// Set the camera sensor image orientation (pixel readout direction).
    ///
    /// Requires depthai-core **v3.4.0+** (RVC2 devices).
    pub fn set_image_orientation(&self, orientation: CameraImageOrientation) -> Result<()> {
        clear_error_flag();
        unsafe {
            depthai::dai_camera_set_image_orientation(
                self.node.handle() as DaiCameraNode,
                c_int(orientation.as_raw()),
            )
        };
        if let Some(err) = take_error_if_any("failed to set camera image orientation") {
            return Err(err);
        }
        Ok(())
    }

    /// Get the camera sensor image orientation currently configured.
    ///
    /// Requires depthai-core **v3.4.0+** (RVC2 devices).
    pub fn image_orientation(&self) -> Result<CameraImageOrientation> {
        clear_error_flag();
        let raw: i32 = unsafe {
            depthai::dai_camera_get_image_orientation(self.node.handle() as DaiCameraNode)
        }.into();
        if let Some(err) = take_error_if_any("failed to get camera image orientation") {
            return Err(err);
        }
        Ok(CameraImageOrientation::from_raw(raw))
    }

    pub fn raw_num_frames_pool(&self) -> Result<i32> {
        clear_error_flag();
        let v = unsafe { depthai::dai_camera_get_raw_num_frames_pool(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get raw num frames pool") {
            return Err(err);
        }
        Ok(v.into())
    }

    pub fn max_size_pool_raw(&self) -> Result<i32> {
        clear_error_flag();
        let v = unsafe { depthai::dai_camera_get_max_size_pool_raw(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get raw max size pool") {
            return Err(err);
        }
        Ok(v.into())
    }

    pub fn isp_num_frames_pool(&self) -> Result<i32> {
        clear_error_flag();
        let v = unsafe { depthai::dai_camera_get_isp_num_frames_pool(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get isp num frames pool") {
            return Err(err);
        }
        Ok(v.into())
    }

    pub fn max_size_pool_isp(&self) -> Result<i32> {
        clear_error_flag();
        let v = unsafe { depthai::dai_camera_get_max_size_pool_isp(self.node.handle() as DaiCameraNode) };
        if let Some(err) = take_error_if_any("failed to get isp max size pool") {
            return Err(err);
        }
        Ok(v.into())
    }

    pub fn outputs_num_frames_pool(&self) -> Result<Option<i32>> {
        clear_error_flag();
        let mut out: c_int = c_int(0);
        let ok = unsafe {
            depthai::dai_camera_get_outputs_num_frames_pool(
                self.node.handle() as DaiCameraNode,
                &mut out as *mut c_int,
            )
        };
        if let Some(err) = take_error_if_any("failed to get outputs num frames pool") {
            return Err(err);
        }
        Ok(if ok { Some(out.into()) } else { None })
    }

    pub fn outputs_max_size_pool(&self) -> Result<Option<usize>> {
        clear_error_flag();
        let mut out: usize = 0;
        let ok = unsafe {
            depthai::dai_camera_get_outputs_max_size_pool(
                self.node.handle() as DaiCameraNode,
                &mut out as *mut usize,
            )
        };
        if let Some(err) = take_error_if_any("failed to get outputs max size pool") {
            return Err(err);
        }
        Ok(if ok { Some(out) } else { None })
    }
}

impl Drop for OutputQueue {
    fn drop(&mut self) {
        if !self.handle.is_null() {
            unsafe { depthai::dai_queue_delete(self.handle) };
        }
    }
}

impl OutputQueue {
    pub(crate) fn from_handle(handle: DaiDataQueue) -> Self {
        Self { handle }
    }

    pub(crate) fn handle(&self) -> DaiDataQueue {
        self.handle
    }

    pub fn blocking_next(&self, timeout: Option<Duration>) -> Result<Option<ImageFrame>> {
        clear_error_flag();
        let timeout_ms = timeout.map(|d| d.as_millis() as i32).unwrap_or(-1);
        let frame = unsafe { depthai::dai_queue_get_frame(self.handle, c_int(timeout_ms)) };
        if frame.is_null() {
            if let Some(err) = take_error_if_any("failed to pull frame") {
                Err(err)
            } else {
                Ok(None)
            }
        } else {
            Ok(Some(ImageFrame { handle: frame }))
        }
    }

    pub fn try_next(&self) -> Result<Option<ImageFrame>> {
        clear_error_flag();
        let frame = unsafe { depthai::dai_queue_try_get_frame(self.handle) };
        if frame.is_null() {
            if let Some(err) = take_error_if_any("failed to poll frame") {
                Err(err)
            } else {
                Ok(None)
            }
        } else {
            Ok(Some(ImageFrame { handle: frame }))
        }
    }
}

impl Drop for ImageFrame {
    fn drop(&mut self) {
        if !self.handle.is_null() {
            unsafe { depthai::dai_frame_release(self.handle) };
        }
    }
}

impl ImageFrame {
    pub(crate) fn from_handle(handle: DaiImgFrame) -> Self {
        Self { handle }
    }

    pub(crate) fn handle(&self) -> DaiImgFrame {
        self.handle
    }

    pub fn width(&self) -> u32 {
        let raw: ::std::os::raw::c_int = unsafe { depthai::dai_frame_get_width(self.handle) }.into();
        raw as u32
    }

    pub fn height(&self) -> u32 {
        let raw: ::std::os::raw::c_int = unsafe { depthai::dai_frame_get_height(self.handle) }.into();
        raw as u32
    }

    pub fn format(&self) -> Option<ImageFrameType> {
        let raw: ::std::os::raw::c_int = unsafe { depthai::dai_frame_get_type(self.handle) }.into();
        ImageFrameType::from_raw(raw)
    }

    pub fn byte_len(&self) -> usize {
        let raw: usize = unsafe { depthai::dai_frame_get_size(self.handle) }.into();
        raw
    }

    pub fn bytes(&self) -> Vec<u8> {
        let len = self.byte_len();
        if len == 0 {
            return Vec::new();
        }
        let data_ptr = unsafe { depthai::dai_frame_get_data(self.handle) };
        if data_ptr.is_null() {
            return Vec::new();
        }
        unsafe { std::slice::from_raw_parts(data_ptr as *const u8, len).to_vec() }
    }

    pub fn describe(&self) -> String {
        let fmt = self
            .format()
            .map(|f| format!("{f:?}"))
            .unwrap_or_else(|| "unknown".into());
        format!("{}x{} {}", self.width(), self.height(), fmt)
    }
}

// Implement DeviceNodeWithParams for CameraNode to enable pipeline.create_with::<CameraNode, _>(socket)
impl CreateInPipelineWith<CameraBoardSocket> for CameraNode {
    fn create_with(pipeline: &Pipeline, socket: CameraBoardSocket) -> Result<Self> {
        pipeline.create_camera(socket)
    }
}