src/common/session/display.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ascii-chat/platform/terminal.h>
#include <ascii-chat/video/ascii/palette.h>
#include <ascii-chat/video/rgba/image.h>
 
/* ============================================================================
 * Session Display Configuration
 * ============================================================================ */
 
typedef bool (*session_display_should_exit_fn)(void *user_data);
 
typedef struct {
  bool snapshot_mode;
 
  palette_type_t palette_type;
 
  const char *custom_palette;
 
  terminal_color_mode_t color_mode;
 
  bool enable_audio_playback;
 
  void *audio_ctx;
 
  session_display_should_exit_fn should_exit_callback;
 
  void *callback_data;
 
  uint32_t render_fps;
 
  bool defer_render_file;
 
} session_display_config_t;
 
/* ============================================================================
 * Session Display Context
 * ============================================================================ */
 
typedef struct session_display_ctx session_display_ctx_t;
 
/* ============================================================================
 * Session Display Lifecycle Functions
 * @{
 */
 
session_display_ctx_t *session_display_create(const session_display_config_t *config);
 
session_display_ctx_t *session_display_get_global_context(void);
 
void session_display_set_global_context_public(session_display_ctx_t *ctx);
 
void session_display_destroy(session_display_ctx_t *ctx);
 
void session_display_set_stdin_reader(session_display_ctx_t *ctx, void *reader);
 
/* ============================================================================
 * Session Display Query Functions
 * @{
 */
 
bool session_display_has_tty(session_display_ctx_t *ctx);
 
const terminal_capabilities_t *session_display_get_caps(session_display_ctx_t *ctx);
 
const char *session_display_get_palette_chars(session_display_ctx_t *ctx);
 
size_t session_display_get_palette_len(session_display_ctx_t *ctx);
 
const char *session_display_get_luminance_palette(session_display_ctx_t *ctx);
 
int session_display_get_tty_fd(session_display_ctx_t *ctx);
 
void *session_display_get_stdin_reader(session_display_ctx_t *ctx);
 
bool session_display_has_render_file(session_display_ctx_t *ctx);
 
uint32_t session_display_get_render_fps(session_display_ctx_t *ctx);
 
asciichat_error_t session_display_init_render_file(session_display_ctx_t *ctx, uint32_t fps);
 
void session_display_set_render_live_timing(session_display_ctx_t *ctx);
 
void session_display_set_render_fps(session_display_ctx_t *ctx, uint32_t fps);
 
bool session_display_has_first_frame(session_display_ctx_t *ctx);
 
void session_display_reset_first_frame(session_display_ctx_t *ctx);
 
/* ============================================================================
 * Session Display ASCII Conversion Functions
 * @{
 */
 
char *session_display_convert_to_ascii(session_display_ctx_t *ctx, const image_t *image);
 
/* ============================================================================
 * Session Display Rendering Functions
 * @{
 */
 
void session_display_write_ascii(session_display_ctx_t *ctx, const char *frame_data);
 
void session_display_encode_frame(session_display_ctx_t *ctx, const image_t *image, uint64_t captured_ns);
 
void session_display_render_frame(session_display_ctx_t *ctx, const char *frame_data);
 
void session_display_write_raw(session_display_ctx_t *ctx, const char *data, size_t len);
 
void session_display_render_fps_overlay(session_display_ctx_t *ctx);
 
void session_display_set_snapshot_actual_duration(session_display_ctx_t *ctx, double actual_duration_sec);
 
void session_display_reset(session_display_ctx_t *ctx);
 
void session_display_clear(session_display_ctx_t *ctx);
 
void session_display_cursor_home(session_display_ctx_t *ctx);
 
/* ============================================================================
 * Session Display Audio Functions
 * @{
 */
 
bool session_display_has_audio_playback(session_display_ctx_t *ctx);
 
asciichat_error_t session_display_write_audio(session_display_ctx_t *ctx, const float *buffer, size_t num_samples);