display.h File Reference

🖥️ Unified terminal display abstraction for session-based rendering More...

Go to the source code of this file.

Data Structures
struct	session_display_config_t
	Configuration for session display context. More...

Typedefs
typedef bool(*	session_display_should_exit_fn) (void *user_data)
	Callback type to check if initialization should be cancelled.
typedef struct session_display_ctx	session_display_ctx_t
	Opaque session display context handle.

Functions
session_display_ctx_t *	session_display_create (const session_display_config_t *config)
	Create a new session display context.
session_display_ctx_t *	session_display_get_global_context (void)
	Get the global display context (used for signal handlers and special cleanup)
void	session_display_set_global_context_public (session_display_ctx_t *ctx)
	Set the global display context (public setter for discovery cleanup)
void	session_display_destroy (session_display_ctx_t *ctx)
	Destroy session display context and free resources.
void	session_display_set_stdin_reader (session_display_ctx_t *ctx, void *reader)
	Set stdin frame reader for ASCII-to-video rendering.
bool	session_display_has_tty (session_display_ctx_t *ctx)
	Check if display has a TTY (terminal) available.
const terminal_capabilities_t *	session_display_get_caps (session_display_ctx_t *ctx)
	Get detected terminal capabilities.
const char *	session_display_get_palette_chars (session_display_ctx_t *ctx)
	Get the palette characters string.
size_t	session_display_get_palette_len (session_display_ctx_t *ctx)
	Get the palette character count.
const char *	session_display_get_luminance_palette (session_display_ctx_t *ctx)
	Get the luminance mapping palette.
int	session_display_get_tty_fd (session_display_ctx_t *ctx)
	Get the TTY file descriptor.
void *	session_display_get_stdin_reader (session_display_ctx_t *ctx)
	Get the stdin frame reader for ASCII-to-video rendering.
bool	session_display_has_render_file (session_display_ctx_t *ctx)
	Check if display has render-file configured.
uint32_t	session_display_get_render_fps (session_display_ctx_t *ctx)
	Get the render FPS configured for file output.
asciichat_error_t	session_display_init_render_file (session_display_ctx_t *ctx, uint32_t fps)
	Initialize render-file output after the capture frame rate is known.
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)
	Set the render FPS for file output encoding.
bool	session_display_has_first_frame (session_display_ctx_t *ctx)
	Check if the display has rendered its first frame.
void	session_display_reset_first_frame (session_display_ctx_t *ctx)
	Reset the first frame flag to allow splash screen to show again on next render.
char *	session_display_convert_to_ascii (session_display_ctx_t *ctx, const image_t *image)
	Convert an image to ASCII art using display context and command-line options.
void	session_display_write_ascii (session_display_ctx_t *ctx, const char *frame_data)
	Write ASCII frame to terminal only (no encoding)
void	session_display_encode_frame (session_display_ctx_t *ctx, const image_t *image, uint64_t captured_ns)
	Encode frame to render-file (FFmpeg only, no terminal output)
void	session_display_render_frame (session_display_ctx_t *ctx, const char *frame_data)
	Render an ASCII frame to the terminal.
void	session_display_write_raw (session_display_ctx_t *ctx, const char *data, size_t len)
	Render raw bytes to the terminal without frame processing.
void	session_display_render_fps_overlay (session_display_ctx_t *ctx)
	Render FPS counter overlay in top-right corner.
void	session_display_set_snapshot_actual_duration (session_display_ctx_t *ctx, double actual_duration_sec)
	Set the actual wall-clock duration for snapshot mode frame timing.
void	session_display_reset (session_display_ctx_t *ctx)
	Reset terminal to default state.
void	session_display_clear (session_display_ctx_t *ctx)
	Clear the terminal screen.
void	session_display_cursor_home (session_display_ctx_t *ctx)
	Move cursor to home position (top-left)
bool	session_display_has_audio_playback (session_display_ctx_t *ctx)
	Check if display has audio playback configured.
asciichat_error_t	session_display_write_audio (session_display_ctx_t *ctx, const float *buffer, size_t num_samples)
	Write audio samples to playback buffer.

Detailed Description

🖥️ Unified terminal display abstraction for session-based rendering

Definition in file src/common/session/display.h.

Function Documentation

session_display_init_render_file()

asciichat_error_t session_display_init_render_file	(	session_display_ctx_t *	ctx,
		uint32_t	fps
	)

Initialize render-file output after the capture frame rate is known.

Parameters

ctx	Display context
fps	Frame rate used for output timing

Returns

ASCIICHAT_OK on success

Initialize render-file output after the capture frame rate is known.

Executes comprehensive terminal reset sequence for clean display state. Skips terminal control operations in snapshot mode.

Parameters

snapshot_mode

Whether snapshot mode is enabled

Definition at line 128 of file src/common/session/display.c.

                                                                                             {
  if (!ctx) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Display context is NULL");
  }
 
  const char *render_file_opt = GET_OPTION(render_file);
  if (!render_file_opt || render_file_opt[0] == '\0') {
    return ASCIICHAT_OK;
  }
  if (ctx->render_file) {
    return ASCIICHAT_OK;
  }
 
  uint32_t encoder_fps = fps;
  if (encoder_fps == 0) {
    encoder_fps = (uint32_t)GET_OPTION(fps);
  }
  if (encoder_fps == 0) {
    encoder_fps = 60;
  }
 
  int width = (int)GET_OPTION(width);
  int height = (int)GET_OPTION(height);
  ctx->render_fps = encoder_fps;
 
  log_info("render-file: Initializing encoder after media timing selection: path='%s', grid=%dx%d, fps=%u",
           render_file_opt, width, height, encoder_fps);
  asciichat_error_t err =
      render_file_create(render_file_opt, width, height, (int)encoder_fps, GET_OPTION(render_theme), &ctx->render_file);
  if (err != ASCIICHAT_OK) {
    log_error("render-file: Failed to create encoder with error %d", err);
    return err;
  }
 
  log_info("render-file: Encoder initialized successfully at %u FPS", encoder_fps);
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, GET_OPTION, log_error, log_info, session_display_ctx::render_file, render_file_create(), session_display_ctx::render_fps, and SET_ERRNO.

Referenced by session_client_like_run(), and session_display_create().

session_display_set_render_live_timing()

void session_display_set_render_live_timing

(

session_display_ctx_t *

ctx

)

Definition at line 940 of file src/common/session/display.c.

                                                                        {
  if (ctx && ctx->render_file)
    render_file_set_live_timing(ctx->render_file);
}

References session_display_ctx::render_file, and render_file_set_live_timing().

Referenced by session_pipeline_create().