isaac-sim-rerun 0.1.0

Rerun viewer adapter for Isaac Sim sensor pipelines.
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

// SPDX-License-Identifier: MPL-2.0
use std::sync::Arc;

use isaac_sim_bridge::{register_camera_rgb_consumer, CameraRgb, CameraRgbMeta};
use rerun::{Image, RecordingStream};

use crate::dispatch::{spawn_drain, LatestSlot};
use crate::sensor::RerunRender;

struct Frame {
    pixels: Arc<[u8]>,
    meta: CameraRgbMeta,
}

impl RerunRender for CameraRgb {
    fn register(rec: RecordingStream, source: String, entity_path: String) {
        register_rerun_camera_rgb_publisher(rec, source, entity_path);
    }
}

pub fn log_camera_rgb(
    rec: &RecordingStream,
    entity_path: &str,
    pixels: &[u8],
    meta: &CameraRgbMeta,
) -> eyre::Result<()> {
    if meta.width <= 0 || meta.height <= 0 {
        return Ok(());
    }
    let expected = (meta.width as usize) * (meta.height as usize) * 3;
    if pixels.len() != expected {
        log::warn!(
            "[isaac-sim-rerun] camera_rgb pixel/dimension mismatch for '{entity_path}': \
             pixels={} width={} height={} (expected {expected} bytes)",
            pixels.len(),
            meta.width,
            meta.height
        );
        return Ok(());
    }
    let img = Image::from_rgb24(pixels, [meta.width as u32, meta.height as u32]);
    rec.log(entity_path, &img)?;
    Ok(())
}

pub fn register_rerun_camera_rgb_publisher(
    rec: RecordingStream,
    source: String,
    entity_path: String,
) {
    let filter = isaac_sim_bridge::SourceFilter::exact(source.clone());
    let (slot, wake) = LatestSlot::<Frame>::new();
    let entity_path_for_drain = entity_path.clone();
    let source_for_drain = source.clone();
    let drain_name = format!("rerun-drain-camera_rgb:{source}");
    let _ = spawn_drain(&drain_name, slot.clone(), wake, move |frame| {
        if let Err(e) = log_camera_rgb(&rec, &entity_path_for_drain, &frame.pixels, &frame.meta) {
            log::warn!(
                "[isaac-sim-rerun] log failed for '{source_for_drain}' -> '{entity_path_for_drain}': {e}"
            );
        }
    });
    register_camera_rgb_consumer(move |src, pixels, meta| {
        if !filter.matches(src) {
            return;
        }
        slot.publish(Frame {
            pixels: Arc::from(pixels),
            meta: *meta,
        });
    });
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn log_camera_rgb_writes_to_memory_sink() {
        let pixels = vec![128_u8; 4 * 4 * 3];
        let meta = CameraRgbMeta {
            width: 4,
            height: 4,
            fx: 0.0,
            fy: 0.0,
            cx: 0.0,
            cy: 0.0,
            timestamp_ns: 0,
        };
        let (rec, storage) = rerun::RecordingStreamBuilder::new("isaac-sim-rerun-test")
            .memory()
            .expect("memory recording");
        log_camera_rgb(&rec, "scene/camera/rgb", &pixels, &meta).expect("log");
        rec.flush_blocking().expect("flush");
        assert!(!storage.take().is_empty());
    }

    #[test]
    fn log_camera_rgb_skips_mismatched_buffer() {
        let pixels = vec![0_u8; 5]; // wrong size for 4x4 RGB
        let meta = CameraRgbMeta {
            width: 4,
            height: 4,
            fx: 0.0,
            fy: 0.0,
            cx: 0.0,
            cy: 0.0,
            timestamp_ns: 0,
        };
        let (rec, _storage) = rerun::RecordingStreamBuilder::new("isaac-sim-rerun-test")
            .memory()
            .expect("memory recording");
        // The mismatched buffer must not panic and must return Ok — it's
        // dropped with a warn log so a downstream consumer can never see
        // a wrong-sized image.
        log_camera_rgb(&rec, "scene/camera/rgb", &pixels, &meta)
            .expect("log returns Ok on mismatch");
    }
}