tui/controller.h

Go to the documentation of this file.

#pragma once
 
#include <ascii-chat/asciichat_errno.h>
#include <libplatform/terminal.h>
#include <stddef.h>
#include <ascii-chat/video/anim/controller.h>

#define UI_CONTROLLER_MAX_FRAME_BYTES (16 * 1024 * 1024)

typedef enum {
  UI_SCREEN_STATUS,
  UI_SCREEN_MEDIA,
  UI_SCREEN_SPLASH,
  UI_SCREEN_RENDER_PROGRESS,
  UI_SCREEN_LOGS,
  UI_SCREEN_ERRNO,
  UI_SCREEN_HELP,
  UI_SCREEN_STATS,
  UI_SCREEN_SYNC,
  UI_SCREEN_MDNS,
  UI_SCREEN_UPDATE,
  UI_SCREEN_NOTICE,
  UI_SCREEN_PROMPT,
  UI_SCREEN_ERROR, // Virtual notification layer; rendered above screens and below help.
  UI_SCREEN_COUNT
} ui_screen_t;
 
typedef void (*ui_render_fn)(terminal_size_t size, const void *snapshot);

asciichat_error_t ui_controller_submit(ui_screen_t screen, int fd, terminal_size_t minimum, ui_render_fn render,
                                       const void *snapshot, size_t bytes);
void ui_controller_remove(ui_screen_t screen);
void ui_controller_dismiss(ui_screen_t screen, int previous);
void ui_controller_shutdown(void);
asciichat_error_t ui_controller_title_start(const char *mode, int fd);
typedef enum { UI_TITLE_IDLE, UI_TITLE_RENDERING, UI_TITLE_FINALIZING, UI_TITLE_FAILED } ui_title_render_t;
void ui_controller_title_render(ui_title_render_t phase);
void ui_controller_title_ready(void);
typedef enum {
  UI_TITLE_ACTIVITY_IDLE,
  UI_TITLE_LOADING_URL,
  UI_TITLE_CONNECTING,
  UI_TITLE_RECONNECTING,
  UI_TITLE_CREATING_SESSION,
  UI_TITLE_JOINING_SESSION,
  UI_TITLE_WAITING_PEERS
} ui_title_activity_t;
void ui_controller_title_activity(ui_title_activity_t activity);
void ui_controller_title_discovery(bool has_session, bool joining);
void ui_controller_packet_begin(void);
void ui_controller_packet_end(void);
void ui_controller_restore_terminal(void);
void ui_controller_redraw(void);
void ui_controller_show_volume(void);
void ui_controller_toggle_logs(void);
void ui_controller_hide_logs(void);
bool ui_controller_is_blocked(void);
bool ui_controller_is_presenting(void);
bool ui_controller_is_owner(void);
terminal_size_t ui_controller_size(void);
typedef struct {
  int screen;
  bool covered;
} ui_presentation_state_t;
ui_presentation_state_t ui_controller_state(void);
int ui_controller_current_screen(void);
int ui_controller_active_fd(void);
int ui_controller_interactive_screen(void);
void ui_controller_select_interactive(int screen);

asciichat_error_t ui_controller_write(int fd, const char *data, size_t len);

size_t ui_controller_trim_utf8_chunk(const char *data, size_t length);
void ui_controller_finish(int fd, const char *data, size_t len);

asciichat_error_t ui_controller_present(ui_screen_t screen, int fd, terminal_size_t minimum, const char *data,
                                        size_t len);
 
asciichat_error_t ui_controller_printf(int fd, const char *format, ...);

const animation_sample_t *ui_controller_animation_sample(void);

asciichat_error_t ui_controller_present_retained(ui_screen_t screen, int fd, terminal_size_t minimum, const char *data,
                                                 size_t len);

void ui_controller_frame_acquired_at(uint64_t started_ns);
void ui_controller_set_effective_fps(unsigned int fps);

asciichat_error_t ui_controller_start_terminal(int fd);
bool ui_controller_screen_live(ui_screen_t screen);
bool ui_controller_first_use_key(int key);