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
use egui::NumExt as _;
use itertools::Itertools;

use re_format::format_uint;
use re_renderer::WgpuResourcePoolStatistics;
use re_smart_channel::{ReceiveSet, SmartChannelSource};
use re_ui::{ContextExt as _, UICommand, UiExt as _};
use re_viewer_context::StoreContext;

use crate::{app_blueprint::AppBlueprint, App};

pub fn top_panel(
    frame: &eframe::Frame,
    app: &mut App,
    app_blueprint: &AppBlueprint<'_>,
    store_context: Option<&StoreContext<'_>>,
    gpu_resource_stats: &WgpuResourcePoolStatistics,
    ui: &mut egui::Ui,
) {
    re_tracing::profile_function!();

    let style_like_web = app.is_screenshotting();
    let top_bar_style = ui.ctx().top_bar_style(style_like_web);
    let top_panel_frame = re_ui::DesignTokens::top_panel_frame();

    let mut content = |ui: &mut egui::Ui, show_content: bool| {
        // React to dragging and double-clicking the top bar:
        #[cfg(not(target_arch = "wasm32"))]
        if !re_ui::NATIVE_WINDOW_BAR {
            // Interact with background first, so that buttons in the top bar gets input priority
            // (last added widget has priority for input).
            let title_bar_response = ui.interact(
                ui.max_rect(),
                ui.id().with("background"),
                egui::Sense::click(),
            );
            if title_bar_response.double_clicked() {
                let maximized = ui.input(|i| i.viewport().maximized.unwrap_or(false));
                ui.ctx()
                    .send_viewport_cmd(egui::ViewportCommand::Maximized(!maximized));
            } else if title_bar_response.is_pointer_button_down_on() {
                // TODO(emilk): This should probably only run on `title_bar_response.drag_started_by(PointerButton::Primary)`,
                // see https://github.com/emilk/egui/pull/4656
                ui.ctx().send_viewport_cmd(egui::ViewportCommand::StartDrag);
            }
        }

        egui::menu::bar(ui, |ui| {
            ui.set_height(top_bar_style.height);
            ui.add_space(top_bar_style.indent);

            if show_content {
                top_bar_ui(
                    frame,
                    app,
                    app_blueprint,
                    store_context,
                    ui,
                    gpu_resource_stats,
                );
            }
        });
    };

    let panel = egui::TopBottomPanel::top("top_bar")
        .frame(top_panel_frame)
        .exact_height(top_bar_style.height);
    let is_expanded = app_blueprint.top_panel_state().is_expanded();

    // On MacOS, we show the close/minimize/maximize buttons in the top panel.
    // We _always_ want to show the top panel in that case, and only hide its content.
    if !re_ui::NATIVE_WINDOW_BAR {
        panel.show_inside(ui, |ui| content(ui, is_expanded));
    } else {
        panel.show_animated_inside(ui, is_expanded, |ui| content(ui, is_expanded));
    }
}

fn top_bar_ui(
    frame: &eframe::Frame,
    app: &mut App,
    app_blueprint: &AppBlueprint<'_>,
    store_context: Option<&StoreContext<'_>>,
    ui: &mut egui::Ui,
    gpu_resource_stats: &WgpuResourcePoolStatistics,
) {
    app.rerun_menu_button_ui(frame, store_context, ui);

    ui.add_space(12.0);
    website_link_ui(ui);

    if app.app_options().show_metrics && !app.is_screenshotting() {
        ui.separator();
        frame_time_label_ui(ui, app);
        memory_use_label_ui(ui, gpu_resource_stats);

        latency_ui(ui, app, store_context);
    }

    ui.with_layout(egui::Layout::right_to_left(egui::Align::Center), |ui| {
        if re_ui::CUSTOM_WINDOW_DECORATIONS && !cfg!(target_arch = "wasm32") {
            ui.add_space(8.0);
            #[cfg(not(target_arch = "wasm32"))]
            ui.native_window_buttons_ui();
            ui.separator();
        } else {
            // Make the first button the same distance form the side as from the top,
            // no matter how high the top bar is.
            let extra_margin = (ui.available_height() - 24.0) / 2.0;
            ui.add_space(extra_margin);
        }

        panel_buttons_r2l(app, app_blueprint, ui);

        if !app.is_screenshotting() {
            connection_status_ui(ui, app.msg_receive_set());
        }

        if let Some(wgpu) = frame.wgpu_render_state() {
            let info = wgpu.adapter.get_info();
            if info.device_type == wgpu::DeviceType::Cpu {
                // TODO(#4304): replace with a panel showing recent log messages
                ui.hyperlink_to(
                    egui::RichText::new("⚠ Software rasterizer ⚠")
                        .small()
                        .color(ui.visuals().warn_fg_color),
                    "https://www.rerun.io/docs/getting-started/troubleshooting#graphics-issues",
                )
                .on_hover_ui(|ui| {
                    ui.label("Software rasterizer detected - expect poor performance.");
                    ui.label(
                        "Rerun requires hardware accelerated graphics (i.e. a GPU) for good performance.",
                    );
                    ui.label("Click for troubleshooting.");
                    ui.add_space(8.0);
                    ui.label(format!(
                        "wgpu adapter {}",
                        re_renderer::adapter_info_summary(&info)
                    ));
                });
            }
        }

        // Warn if in debug build
        if cfg!(debug_assertions) && !app.is_screenshotting() {
            ui.vertical_centered(|ui| {
                ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend);
                ui.add_space(6.0); // TODO(emilk): in egui, add a proper way of centering a single widget in a UI.
                egui::warn_if_debug_build(ui);
            });
        }
    });
}

fn connection_status_ui(ui: &mut egui::Ui, rx: &ReceiveSet<re_log_types::LogMsg>) {
    let sources = rx
        .sources()
        .into_iter()
        .filter(|source| {
            match source.as_ref() {
                SmartChannelSource::File(_)
                | SmartChannelSource::RrdHttpStream { .. }
                | SmartChannelSource::RerunGrpcStream { .. }
                | SmartChannelSource::Stdin => {
                    false // These show up in the recordings panel as a "Loading…" in `recordings_panel.rs`
                }

                re_smart_channel::SmartChannelSource::RrdWebEventListener
                | re_smart_channel::SmartChannelSource::Sdk
                | re_smart_channel::SmartChannelSource::WsClient { .. }
                | re_smart_channel::SmartChannelSource::TcpServer { .. }
                | re_smart_channel::SmartChannelSource::JsChannel { .. } => true,
            }
        })
        .collect_vec();

    match sources.len() {
        0 => return,
        1 => {
            source_label(ui, sources[0].as_ref());
        }
        n => {
            // In practice we never get here
            ui.label(format!("{n} sources connected"))
                .on_hover_ui(|ui| {
                    ui.vertical(|ui| {
                        for source in &sources {
                            source_label(ui, source.as_ref());
                        }
                    });
                });
        }
    }

    fn source_label(ui: &mut egui::Ui, source: &SmartChannelSource) -> egui::Response {
        let response = ui.label(status_string(source));

        let tooltip = match source {
            SmartChannelSource::File(_)
            | SmartChannelSource::Stdin
            | SmartChannelSource::RrdHttpStream { .. }
            | SmartChannelSource::RerunGrpcStream { .. }
            | SmartChannelSource::RrdWebEventListener
            | SmartChannelSource::JsChannel { .. }
            | SmartChannelSource::Sdk
            | SmartChannelSource::WsClient { .. } => None,

            SmartChannelSource::TcpServer { .. } => {
                Some("Waiting for an SDK to connect".to_owned())
            }
        };

        if let Some(tooltip) = tooltip {
            response.on_hover_text(tooltip)
        } else {
            response
        }
    }

    fn status_string(source: &SmartChannelSource) -> String {
        match source {
            re_smart_channel::SmartChannelSource::File(path) => {
                format!("Loading {}…", path.display())
            }
            re_smart_channel::SmartChannelSource::Stdin => "Loading stdin…".to_owned(),
            re_smart_channel::SmartChannelSource::RrdHttpStream { url, .. }
            | re_smart_channel::SmartChannelSource::RerunGrpcStream { url } => {
                format!("Loading {url}…")
            }
            re_smart_channel::SmartChannelSource::RrdWebEventListener
            | re_smart_channel::SmartChannelSource::JsChannel { .. } => {
                "Waiting for logging data…".to_owned()
            }
            re_smart_channel::SmartChannelSource::Sdk => {
                "Waiting for logging data from SDK".to_owned()
            }
            re_smart_channel::SmartChannelSource::WsClient { ws_server_url } => {
                // TODO(emilk): it would be even better to know whether or not we are connected, or are attempting to connect
                format!("Waiting for data from {ws_server_url}")
            }
            re_smart_channel::SmartChannelSource::TcpServer { port } => {
                format!("Listening on TCP port {port}")
            }
        }
    }
}

/// Lay out the panel button right-to-left
fn panel_buttons_r2l(app: &App, app_blueprint: &AppBlueprint<'_>, ui: &mut egui::Ui) {
    #[cfg(target_arch = "wasm32")]
    if app.is_fullscreen_allowed() {
        let icon = if app.is_fullscreen_mode() {
            &re_ui::icons::MINIMIZE
        } else {
            &re_ui::icons::MAXIMIZE
        };

        if ui
            .medium_icon_toggle_button(icon, &mut true)
            .on_hover_text("Toggle fullscreen")
            .clicked()
        {
            app.toggle_fullscreen();
        }
    }

    // selection panel
    if !app_blueprint.selection_panel_overridden()
        && ui
            .medium_icon_toggle_button(
                &re_ui::icons::RIGHT_PANEL_TOGGLE,
                &mut app_blueprint.selection_panel_state().is_expanded(),
            )
            .on_hover_text(format!(
                "Toggle selection view{}",
                UICommand::ToggleSelectionPanel.format_shortcut_tooltip_suffix(ui.ctx())
            ))
            .clicked()
    {
        app_blueprint.toggle_selection_panel(&app.command_sender);
    }

    // time panel
    if !app_blueprint.time_panel_overridden()
        && ui
            .medium_icon_toggle_button(
                &re_ui::icons::BOTTOM_PANEL_TOGGLE,
                &mut app_blueprint.time_panel_state().is_expanded(),
            )
            .on_hover_text(format!(
                "Toggle timeline view{}",
                UICommand::ToggleTimePanel.format_shortcut_tooltip_suffix(ui.ctx())
            ))
            .clicked()
    {
        app_blueprint.toggle_time_panel(&app.command_sender);
    }

    // blueprint panel
    if !app_blueprint.blueprint_panel_overridden()
        && ui
            .medium_icon_toggle_button(
                &re_ui::icons::LEFT_PANEL_TOGGLE,
                &mut app_blueprint.blueprint_panel_state().is_expanded(),
            )
            .on_hover_text(format!(
                "Toggle blueprint view{}",
                UICommand::ToggleBlueprintPanel.format_shortcut_tooltip_suffix(ui.ctx())
            ))
            .clicked()
    {
        app_blueprint.toggle_blueprint_panel(&app.command_sender);
    }
}

/// Shows clickable website link as an image (text doesn't look as nice)
fn website_link_ui(ui: &mut egui::Ui) {
    let desired_height = ui.max_rect().height();
    let desired_height = desired_height.at_most(28.0); // figma size 2023-02-03

    let image = re_ui::icons::RERUN_IO_TEXT
        .as_image()
        .max_height(desired_height);

    let url = "https://rerun.io/";
    let response = ui
        .add(egui::ImageButton::new(image))
        .on_hover_cursor(egui::CursorIcon::PointingHand);
    if response.clicked() {
        ui.ctx().open_url(egui::output::OpenUrl {
            url: url.to_owned(),
            new_tab: true,
        });
    }
}

fn frame_time_label_ui(ui: &mut egui::Ui, app: &App) {
    if let Some(frame_time) = app.frame_time_history.average() {
        let ms = frame_time * 1e3;

        let visuals = ui.visuals();
        let color = if ms < 15.0 {
            visuals.weak_text_color()
        } else {
            visuals.warn_fg_color
        };

        // we use monospace so the width doesn't fluctuate as the numbers change.
        let text = format!("{ms:.1} ms");
        ui.label(egui::RichText::new(text).monospace().color(color))
            .on_hover_text("CPU time used by Rerun Viewer each frame. Lower is better.");
    }
}

fn memory_use_label_ui(ui: &mut egui::Ui, gpu_resource_stats: &WgpuResourcePoolStatistics) {
    const CODE: &str = "use re_memory::AccountingAllocator;\n\
                        #[global_allocator]\n\
                        static GLOBAL: AccountingAllocator<std::alloc::System> =\n    \
                            AccountingAllocator::new(std::alloc::System);";

    fn click_to_copy(
        ui: &mut egui::Ui,
        text: impl Into<String>,
        add_contents_on_hover: impl FnOnce(&mut egui::Ui),
    ) {
        #[allow(clippy::blocks_in_conditions)]
        let text = text.into();
        if ui
            .add(
                egui::Label::new(
                    egui::RichText::new(text)
                        .monospace()
                        .color(ui.visuals().weak_text_color()),
                )
                .sense(egui::Sense::click()),
            )
            .on_hover_ui(|ui| add_contents_on_hover(ui))
            .clicked()
        {
            ui.ctx().output_mut(|o| o.copied_text = CODE.to_owned());
        }
    }

    let mem = re_memory::MemoryUse::capture();

    if let Some(count) = re_memory::accounting_allocator::global_allocs() {
        // we use monospace so the width doesn't fluctuate as the numbers change.

        let bytes_used_text = re_format::format_bytes(count.size as _);
        ui.label(
            egui::RichText::new(&bytes_used_text)
                .monospace()
                .color(ui.visuals().weak_text_color()),
        )
        .on_hover_text(format!(
            "Rerun Viewer is using {} of RAM in {} separate allocations,\n\
            plus {} of GPU memory in {} textures and {} buffers.",
            bytes_used_text,
            format_uint(count.count),
            re_format::format_bytes(gpu_resource_stats.total_bytes() as _),
            format_uint(gpu_resource_stats.num_textures),
            format_uint(gpu_resource_stats.num_buffers),
        ));
    } else if let Some(rss) = mem.resident {
        let bytes_used_text = re_format::format_bytes(rss as _);
        click_to_copy(ui, &bytes_used_text, |ui| {
            ui.label(format!(
                "Rerun Viewer is using {} of Resident memory (RSS),\n\
                plus {} of GPU memory in {} textures and {} buffers.",
                bytes_used_text,
                re_format::format_bytes(gpu_resource_stats.total_bytes() as _),
                format_uint(gpu_resource_stats.num_textures),
                format_uint(gpu_resource_stats.num_buffers),
            ));
            ui.label(
                "To get more accurate memory reportings, consider configuring your Rerun \n\
                 viewer to use an AccountingAllocator by adding the following to your \n\
                 code's main entrypoint:",
            );
            ui.code(CODE);
            ui.label("(click to copy to clipboard)");
        });
    } else {
        click_to_copy(ui, "N/A MiB", |ui| {
            ui.label(
                "The Rerun viewer was not configured to run with an AccountingAllocator,\n\
                consider adding the following to your code's main entrypoint:",
            );
            ui.code(CODE);
            ui.label("(click to copy to clipboard)");
        });
    }
}

fn latency_ui(ui: &mut egui::Ui, app: &mut App, store_context: Option<&StoreContext<'_>>) {
    if let Some(response) = e2e_latency_ui(ui, store_context) {
        // Show queue latency on hover, as that is part of this.
        // For instance, if the framerate is really bad we have less time to ingest incoming data,
        // leading to an ever-increasing input queue.
        let rx = app.msg_receive_set();
        let queue_len = rx.queue_len();
        let latency_sec = rx.latency_ns() as f32 / 1e9;
        // empty queue == unreliable latency
        if 0 < queue_len {
            response.on_hover_ui(|ui| {
                ui.label(format!(
                    "Queue latency: {}, length: {}",
                    latency_text(latency_sec),
                    format_uint(queue_len),
                ));

                ui.label(
                    "When more data is arriving over network than the Rerun Viewer can ingest, a queue starts building up, leading to latency and increased RAM use.\n\
                         We call this the queue latency.");
            });
        }
    } else {
        // If we don't know the e2e latency we can still show the queue latency.
        input_queue_latency_ui(ui, app);
    }
}

/// Shows the e2e latency.
fn e2e_latency_ui(
    ui: &mut egui::Ui,
    store_context: Option<&StoreContext<'_>>,
) -> Option<egui::Response> {
    let store_context = store_context?;
    let recording = store_context.recording;
    let e2e_latency_sec = recording.ingestion_stats().current_e2e_latency_sec()?;

    if e2e_latency_sec > 60.0 {
        return None; // Probably an old recording and not live data.
    }

    let text = format!("latency: {}", latency_text(e2e_latency_sec));
    let response = ui.weak(text);

    let hover_text = "End-to-end latency from when the data was logged by the SDK to when it is shown in the viewer.\n\
                      This includes time for encoding, network latency, and decoding.\n\
                      It is also affected by the framerate of the viewer.\n\
                      This latency is inaccurate if the logging was done on a different machine, since it is clock-based.";

    Some(response.on_hover_text(hover_text))
}

/// Shows the latency in the input queue.
fn input_queue_latency_ui(ui: &mut egui::Ui, app: &mut App) {
    let rx = app.msg_receive_set();

    if rx.is_empty() {
        return;
    }

    let is_latency_interesting = rx.sources().iter().any(|s| s.is_network());

    let queue_len = rx.queue_len();

    // empty queue == unreliable latency
    let latency_sec = rx.latency_ns() as f32 / 1e9;
    if queue_len > 0 && (!is_latency_interesting || app.app_options().warn_latency < latency_sec) {
        // we use this to avoid flicker
        app.latest_queue_interest = web_time::Instant::now();
    }

    if app.latest_queue_interest.elapsed().as_secs_f32() < 1.0 {
        ui.separator();
        if is_latency_interesting {
            let text = format!(
                "Queue latency: {}, length: {}",
                latency_text(latency_sec),
                format_uint(queue_len),
            );
            let hover_text =
                    "When more data is arriving over network than the Rerun Viewer can ingest, a queue starts building up, leading to latency and increased RAM use.\n\
                    This latency does NOT include network latency.";

            if latency_sec < app.app_options().warn_latency {
                ui.weak(text).on_hover_text(hover_text);
            } else {
                ui.label(ui.ctx().warning_text(text))
                    .on_hover_text(hover_text);
            }
        } else {
            ui.weak(format!("Queue: {}", format_uint(queue_len)))
                .on_hover_text("Number of messages in the inbound queue");
        }
    }
}

fn latency_text(latency_sec: f32) -> String {
    if latency_sec < 1.0 {
        format!("{:.0} ms", 1e3 * latency_sec)
    } else {
        format!("{latency_sec:.1} s")
    }
}