Standard input/output support 4: C++ SDK stdout impl/examples/docs #4514

teh-cmc · 2023-12-13T15:22:08Z

Allow the C++ SDK to stream RRD data to stdout.

Checks:

just py-build && just cpp-build-examples && echo 'hello from stdin!' | ./build/debug/examples/cpp/stdio/example_stdio | rerun -

Part of a small PR series to add stdio streaming support to our Viewer and SDKs:

Checklist

I have read and agree to Contributor Guide and the Code of Conduct
I've included a screenshot or gif (if applicable)
I have tested the web demo (if applicable):
- Full build: app.rerun.io
- Partial build: app.rerun.io - Useful for quick testing when changes do not affect examples in any way
The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

teh-cmc · 2023-12-14T06:52:40Z

docs/content/reference/sdk-operating-modes.md

@@ -80,6 +80,12 @@ Use [`RecordingStream::save`](https://docs.rs/rerun/latest/rerun/struct.Recordin

 Streams all logging data to standard output, which can then be loaded by the Rerun Viewer by streaming it from standard input.

+#### C++
+
+Use [`RecordingStream::stdout`](https://ref.rerun.io/docs/cpp/stable/classrerun_1_1RecordingStream.html#SOMEHASH?speculative-link).


I'm gonna have a hard time coming up with the exact right hash speculatively...

examples/cpp/stdio/main.cpp

teh-cmc · 2023-12-14T07:16:00Z

Huuhh... any idea what Windows is complaining about @Wumpf ? :|

https://github.com/rerun-io/rerun/actions/runs/7205566621/job/19628799638?pr=4514

Wumpf · 2023-12-14T08:01:22Z

@teh-cmc stdout is a forbidden word since there's a preprocessor macro with that name https://learn.microsoft.com/en-us/cpp/c-runtime-library/stdin-stdout-stderr?view=msvc-170

teh-cmc · 2023-12-14T08:09:52Z

@teh-cmc stdout is a forbidden word since there's a preprocessor macro with that name https://learn.microsoft.com/en-us/cpp/c-runtime-library/stdin-stdout-stderr?view=msvc-170

What in the hell... -_- Thanks

Wumpf

example doesn't build yet!

crates/rerun_c/src/rerun.h

examples/cpp/stdio/CMakeLists.txt

rerun_cpp/src/rerun/recording_stream.hpp

examples/cpp/stdio/README.md

Wumpf

👍

Add a `stdin` source to the viewer so it can stream data in from standard input. We make `stdin` an explicit input (`rerun -`) like in the good old days, to avoid shady behavior in non-TTY and other esoteric environment (crazy WSL setups, etc). Trust me, it gets quite insane... Checks: - [x] `rerun` works - [x] `rerun -` blocks - [x] `rerun - < data.rrd` works - [x] `cat data.rrd | rerun -` works - [x] `rerun < data.rrd` works but does nothing - [x] `cat data.rrd | rerun` works but does nothing - [x] no-TTY & other esoteric environments don't go completely off the rails --- Part of a small PR series to add stdio streaming support to our Viewer and SDKs: - #4511 - #4512 - #4513 - #4514

…4512) Allow the Rust SDK to stream RRD data to stdout. Checks: - [x] `just py-build && echo 'hello from stdin!' | cargo run -p stdio | rerun -` --- Part of a small PR series to add stdio streaming support to our Viewer and SDKs: - #4511 - #4512 - #4513 - #4514

…#4513) Allow the Python SDK to stream RRD data to stdout. Checks: - [x] `just py-build && echo 'hello from stdin!' | python examples/python/stdio/main.py | rerun -` --- Part of a small PR series to add stdio streaming support to our Viewer and SDKs: - #4511 - #4512 - #4513 - #4514

…romise

@dataphract

* Uses: rerun-io/egui_tiles#67 * Uses: lampsitter/egui_commonmark#51 * Split off from #6171 * Closes #5280 ### Test * [x] image loading * [x] gltf ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/6448?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/6448?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! - [PR Build Summary](https://build.rerun.io/pr/6448) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`. # egui changelog so far Full diff at https://github.com/emilk/egui/compare/0.27.0..HEAD #### ecolor * Fix `hex_color!` macro by re-exporting `color_hex` crate from `ecolor` [#4372](emilk/egui#4372) (thanks [@dataphract](https://github.com/dataphract)!) * Remove `extra_asserts` and `extra_debug_asserts` feature flags [#4478](emilk/egui#4478) #### eframe * Add `register_native_texture` in `eframe::Frame` [#4246](emilk/egui#4246) (thanks [@Chaojimengnan](https://github.com/Chaojimengnan)!) * Early-out from context switching the `glow` backend [#4284](emilk/egui#4284) * Fix `ViewportCommand::InnerSize` not resizing viewport on Wayland (#4211) [#4211](emilk/egui#4211) (thanks [@rustbasic](https://github.com/rustbasic)!) * Only avoid glow context switching on Windows [#4296](emilk/egui#4296) * Improve IME support with new `Event::Ime` [#4358](emilk/egui#4358) (thanks [@rustbasic](https://github.com/rustbasic)!) * Allow users to create viewports larger than monitor on Windows & macOS [#4337](emilk/egui#4337) (thanks [@lopo12123](https://github.com/lopo12123)!) * Use `objc2` and its framework crates [#4395](emilk/egui#4395) (thanks [@madsmtm](https://github.com/madsmtm)!) * Update to Rust 1.76 [#4411](emilk/egui#4411) * Egui-winit: emit physical key presses when a non-Latin layout is active [#4461](emilk/egui#4461) (thanks [@TicClick](https://github.com/TicClick)!) * IME for chinese [#4436](emilk/egui#4436) (thanks [@rustbasic](https://github.com/rustbasic)!) * Fix : In Windows, the 'egui_demo_app' screen does not appear. [#4410](emilk/egui#4410) (thanks [@rustbasic](https://github.com/rustbasic)!) * Fix: Window position creeps between executions on scaled monitors [#4443](emilk/egui#4443) (thanks [@avery-radmacher](https://github.com/avery-radmacher)!) * Update `image` crate to 0.25 [#4160](emilk/egui#4160) * Ignore synthetic key presses [#4514](emilk/egui#4514) (thanks [@hut](https://github.com/hut)!) * Fix: still track mouse when dragging outside web canvas [#4522](emilk/egui#4522) * Add `NativeOptions::persistence_path` [#4423](emilk/egui#4423) (thanks [@lucasmerlin](https://github.com/lucasmerlin)!) * Use ResizeObserver instead of `resize` event [#4536](emilk/egui#4536) (thanks [@jprochazk](https://github.com/jprochazk)!) * Fix: Don't `.forget()` RAF closure [#4551](emilk/egui#4551) (thanks [@jprochazk](https://github.com/jprochazk)!) #### egui_extras * Update `image` crate to 0.25 [#4160](emilk/egui#4160) #### egui_plot * `Plot::Items:allow_hover` give possibility to masked the interaction on hovered item [#2558](emilk/egui#2558) (thanks [@haricot](https://github.com/haricot)!) * Expose `ClosestElem` and `PlotConfig` [#4380](emilk/egui#4380) (thanks [@Narcha](https://github.com/Narcha)!) * Disable interaction for `ScrollArea` and `Plot` when UI is disabled [#4457](emilk/egui#4457) (thanks [@varphone](https://github.com/varphone)!) * Make sure plot size is positive [#4429](emilk/egui#4429) (thanks [@rustbasic](https://github.com/rustbasic)!) * Introduce lifetime to `egui_plot::Plot` to replace `'static` fields [#4435](emilk/egui#4435) (thanks [@Fabus1184](https://github.com/Fabus1184)!) * Hide all other series when alt-clicking in the legend [#4549](emilk/egui#4549) (thanks [@abey79](https://github.com/abey79)!) * Plot now respects the `interact_radius` set in the UI's style [#4520](emilk/egui#4520) (thanks [@YgorSouza](https://github.com/YgorSouza)!) #### egui_glow * Enable egui_glow's winit feature on wasm (#4420) [#4421](emilk/egui#4421) (thanks [@simon-frankau](https://github.com/simon-frankau)!) #### egui-wgpu * Update to wgpu 0.20 [#4433](emilk/egui#4433) (thanks [@KeKsBoTer](https://github.com/KeKsBoTer)!) * Revert update to wgpu 0.20 => downgrade to wgpu 0.19.1 [#4559](emilk/egui#4559) #### egui-winit * Update `webbrowser` to `v1.0.0` [#4394](emilk/egui#4394) (thanks [@torokati44](https://github.com/torokati44)!) * Emit physical key presses when a non-Latin layout is active [#4461](emilk/egui#4461) (thanks [@TicClick](https://github.com/TicClick)!) * IME for chinese [#4436](emilk/egui#4436) (thanks [@rustbasic](https://github.com/rustbasic)!) * Fix: Window position creeps between executions on scaled monitors [#4443](emilk/egui#4443) (thanks [@avery-radmacher](https://github.com/avery-radmacher)!) * Ignore synthetic key presses [#4514](emilk/egui#4514) (thanks [@hut](https://github.com/hut)!) #### egui * Improve the UI for changing the egui theme [#4257](emilk/egui#4257) * Change the resize cursor when you reach the resize limit [#4275](emilk/egui#4275) * Make `TextEdit` an atomic widget [#4276](emilk/egui#4276) * Overload operators for `Rect + Margin`, `Rect - Margin` etc [#4277](emilk/egui#4277) * Implement blinking text cursor in `TextEdit` [#4279](emilk/egui#4279) * Rename `fn scroll2` to `fn scroll` [#4282](emilk/egui#4282) * Change `Frame::multiply_with_opacity` to multiply in gamma space [#4283](emilk/egui#4283) * Support order on windows [#4301](emilk/egui#4301) (thanks [@alexparlett](https://github.com/alexparlett)!) * Fix wrong replacement function in deprecation notice of `drag_released*` [#4314](emilk/egui#4314) (thanks [@sornas](https://github.com/sornas)!) * Consider layer transform when positioning text agent [#4319](emilk/egui#4319) (thanks [@juancampa](https://github.com/juancampa)!) * Fix incorrect line breaks [#4377](emilk/egui#4377) (thanks [@juancampa](https://github.com/juancampa)!) * Fix `hex_color!` macro by re-exporting `color_hex` crate from `ecolor` [#4372](emilk/egui#4372) (thanks [@dataphract](https://github.com/dataphract)!) * Change `Ui::allocate_painter` to inherit properties from `Ui` [#4343](emilk/egui#4343) (thanks [@varphone](https://github.com/varphone)!) * Use parent `Ui`s style for popups [#4325](emilk/egui#4325) (thanks [@alexparlett](https://github.com/alexparlett)!) * Fix : take `rounding` into account when using `Slider::trailing_fill` [#4308](emilk/egui#4308) (thanks [@rustbasic](https://github.com/rustbasic)!) * Add a way to specify Undoer settings and construct Undoers more easily [#4357](emilk/egui#4357) (thanks [@valadaptive](https://github.com/valadaptive)!) * Add xtask crate [#4293](emilk/egui#4293) (thanks [@YgorSouza](https://github.com/YgorSouza)!) * Add `ViewportCommand::RequestCut`, `RequestCopy` and `RequestPaste` to trigger Clipboard actions [#4035](emilk/egui#4035) (thanks [@bu5hm4nn](https://github.com/bu5hm4nn)!) * Fix `Panel` incorrect size [#4351](emilk/egui#4351) (thanks [@zhatuokun](https://github.com/zhatuokun)!) * Improve IME support with new `Event::Ime` [#4358](emilk/egui#4358) (thanks [@rustbasic](https://github.com/rustbasic)!) * Allow users to create viewports larger than monitor on Windows & macOS [#4337](emilk/egui#4337) (thanks [@lopo12123](https://github.com/lopo12123)!) * Added ability to define colors at UV coordinates along a path [#4353](emilk/egui#4353) (thanks [@murl-digital](https://github.com/murl-digital)!) * Eframe: update ViewportBuilder.with_icon() documentation [#4408](emilk/egui#4408) (thanks [@roccoblues](https://github.com/roccoblues)!) * Update to Rust 1.76 [#4411](emilk/egui#4411) * Add a `Display` impl for `Vec2`, `Pos2`, and `Rect` [#4428](emilk/egui#4428) (thanks [@tgross35](https://github.com/tgross35)!) * Remove `extra_asserts` and `extra_debug_asserts` feature flags [#4478](emilk/egui#4478) * Egui-winit: emit physical key presses when a non-Latin layout is active [#4461](emilk/egui#4461) (thanks [@TicClick](https://github.com/TicClick)!) * Disable interaction for `ScrollArea` and `Plot` when UI is disabled [#4457](emilk/egui#4457) (thanks [@varphone](https://github.com/varphone)!) * Update ahash 0.8.6 -> 0.8.11 [#4507](emilk/egui#4507) (thanks [@hellodword](https://github.com/hellodword)!) * `include_image!` now accepts expressions [#4521](emilk/egui#4521) (thanks [@YgorSouza](https://github.com/YgorSouza)!) * Remove `Event::Scroll` and handle it in egui [#4524](emilk/egui#4524) * Remove scroll latency for smooth trackpads [#4526](emilk/egui#4526) * Smooth out zooming with discreet scroll wheel [#4530](emilk/egui#4530) * Add `Options::line_scroll_speed` and `scroll_zoom_speed` [#4532](emilk/egui#4532) * Don't panic when replacement glyph is not found [#4542](emilk/egui#4542) (thanks [@RyanBluth](https://github.com/RyanBluth)!) * Make `TextEdit::return_key` optional [#4543](emilk/egui#4543) (thanks [@doonv](https://github.com/doonv)!) * Add `TextEdit::hint_text_font` [#4517](emilk/egui#4517) (thanks [@zaaarf](https://github.com/zaaarf)!) * Add `Options::reduce_texture_memory` to free up RAM [#4431](emilk/egui#4431) (thanks [@varphone](https://github.com/varphone)!) * Fix `Ui::scroll_with_delta` only scrolling if the `ScrollArea` is focused [#4303](emilk/egui#4303) (thanks [@lucasmerlin](https://github.com/lucasmerlin)!) * Add support for text truncation to `egui::Style` [#4556](emilk/egui#4556) (thanks [@abey79](https://github.com/abey79)!) * Hide toolip when opening `ComboBox` drop-down [#4546](emilk/egui#4546) (thanks [@abey79](https://github.com/abey79)!) * Better spacing and sizes for (menu) buttons [#4558](emilk/egui#4558) #### epaint * Add `RectShape::blur_width` to implement shadows [#4267](emilk/egui#4267) * Overload operators for `Rect + Margin`, `Rect - Margin` etc [#4277](emilk/egui#4277) * Fix incorrect line breaks [#4377](emilk/egui#4377) (thanks [@juancampa](https://github.com/juancampa)!) * Fix `hex_color!` macro by re-exporting `color_hex` crate from `ecolor` [#4372](emilk/egui#4372) (thanks [@dataphract](https://github.com/dataphract)!) * Add `emath::OrderedFloat` (moved from `epaint::util::OrderedFloat`) [#4389](emilk/egui#4389) * Added ability to define colors at UV coordinates along a path [#4353](emilk/egui#4353) (thanks [@murl-digital](https://github.com/murl-digital)!) * Add a `Display` impl for `Vec2`, `Pos2`, and `Rect` [#4428](emilk/egui#4428) (thanks [@tgross35](https://github.com/tgross35)!) * Remove `extra_asserts` and `extra_debug_asserts` feature flags [#4478](emilk/egui#4478) * Make `epaint::mutex::RwLock` allow `?Sized` types [#4485](emilk/egui#4485) (thanks [@crumblingstatue](https://github.com/crumblingstatue)!) * Update ahash 0.8.6 -> 0.8.11 [#4507](emilk/egui#4507) (thanks [@hellodword](https://github.com/hellodword)!) * Don't panic when replacement glyph is not found [#4542](emilk/egui#4542) (thanks [@RyanBluth](https://github.com/RyanBluth)!) --------- Co-authored-by: Antoine Beyeler <[email protected]> Co-authored-by: Andreas Reich <[email protected]>

teh-cmc added 🧑‍💻 dev experience developer experience (excluding CI) do-not-merge Do not merge this PR 🌊 C++ API C/C++ API specific include in changelog labels Dec 13, 2023

This was referenced Dec 13, 2023

Standard input/output support 1: stream RRD data from stdin #4511

Merged

Standard input/output support 2: Rust SDK stdout impl/examples/docs #4512

Merged

Standard input/output support 3: Python SDK stdout impl/examples/docs #4513

Merged

teh-cmc force-pushed the cmc/stdio_3_python branch from ccadb17 to ae18250 Compare December 13, 2023 19:16

teh-cmc force-pushed the cmc/stdio_4_cpp branch from 03c89e9 to 04c55fe Compare December 13, 2023 19:16

teh-cmc force-pushed the cmc/stdio_3_python branch from ae18250 to 954dfe2 Compare December 13, 2023 19:39

teh-cmc force-pushed the cmc/stdio_4_cpp branch from 04c55fe to 150a0e0 Compare December 13, 2023 19:40

teh-cmc force-pushed the cmc/stdio_3_python branch from 954dfe2 to bcbb76c Compare December 14, 2023 06:43

teh-cmc force-pushed the cmc/stdio_4_cpp branch from 150a0e0 to ab3b687 Compare December 14, 2023 06:46

teh-cmc commented Dec 14, 2023

View reviewed changes

examples/cpp/stdio/main.cpp Outdated Show resolved Hide resolved

teh-cmc marked this pull request as ready for review December 14, 2023 06:54

teh-cmc force-pushed the cmc/stdio_4_cpp branch from 2ef6c08 to f8a9054 Compare December 14, 2023 07:03

Wumpf requested changes Dec 14, 2023

View reviewed changes

crates/rerun_c/src/rerun.h Show resolved Hide resolved

examples/cpp/stdio/CMakeLists.txt Show resolved Hide resolved

rerun_cpp/src/rerun/recording_stream.hpp Show resolved Hide resolved

examples/cpp/stdio/README.md Outdated Show resolved Hide resolved

teh-cmc force-pushed the cmc/stdio_4_cpp branch from ed059ee to f1f95bc Compare December 14, 2023 10:46

teh-cmc requested a review from Wumpf December 14, 2023 10:47

Wumpf approved these changes Dec 14, 2023

View reviewed changes

teh-cmc removed the do-not-merge Do not merge this PR label Dec 14, 2023

teh-cmc force-pushed the cmc/stdio_3_python branch from 81c5d75 to 422f980 Compare December 14, 2023 17:13

Base automatically changed from cmc/stdio_3_python to main December 14, 2023 17:14

teh-cmc added 8 commits December 14, 2023 18:14

add C support for RecordingStream::stdout

06df408

add C++ support for RecordingStream::stdout

a3e12ae

add cpp example

e9214ad

update op docs

087c7e9

update example docs

4e1eda6

remove example bloat

f302f50

c++26 does not yet support the word 'stdout', but we'll get there i p…

d2ea0f7

…romise

address PR comments

bdc1f08

teh-cmc force-pushed the cmc/stdio_4_cpp branch from f1f95bc to bdc1f08 Compare December 14, 2023 17:14

teh-cmc merged commit 55beca2 into main Dec 14, 2023
14 of 22 checks passed

teh-cmc deleted the cmc/stdio_4_cpp branch December 14, 2023 17:14

teh-cmc mentioned this pull request Dec 14, 2023

Pipe .rrd via stdin/stdout #4494

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Standard input/output support 4: C++ SDK stdout impl/examples/docs #4514

Standard input/output support 4: C++ SDK stdout impl/examples/docs #4514

teh-cmc commented Dec 13, 2023 •

edited by github-actions bot

Loading

teh-cmc Dec 14, 2023 •

edited

Loading

teh-cmc commented Dec 14, 2023

Wumpf commented Dec 14, 2023

teh-cmc commented Dec 14, 2023

Wumpf left a comment

Wumpf left a comment

Standard input/output support 4: C++ SDK stdout impl/examples/docs #4514

Standard input/output support 4: C++ SDK stdout impl/examples/docs #4514

Conversation

teh-cmc commented Dec 13, 2023 • edited by github-actions bot Loading

Checklist

teh-cmc Dec 14, 2023 • edited Loading

Choose a reason for hiding this comment

teh-cmc commented Dec 14, 2023

Wumpf commented Dec 14, 2023

teh-cmc commented Dec 14, 2023

Wumpf left a comment

Choose a reason for hiding this comment

Wumpf left a comment

Choose a reason for hiding this comment

teh-cmc commented Dec 13, 2023 •

edited by github-actions bot

Loading

teh-cmc Dec 14, 2023 •

edited

Loading