frame_validation.c File Reference

Go to the source code of this file.

Macros
#define	FRAME_SGR_PARAMETER_CAPACITY   16

Functions
asciichat_error_t	session_frame_validate_contract (const char *text, size_t length, uint32_t width, uint32_t height, const acip_render_settings_t *settings, uint32_t effects)
asciichat_error_t	session_frame_validate (const char *text, size_t length, uint32_t width, uint32_t height)
asciichat_error_t	frame_render_contract_decode (const void *wire, size_t available, acip_render_settings_t *settings, uint32_t *effects, size_t *length)
asciichat_error_t	frame_render_contract_encode (const acip_render_settings_t *settings, uint32_t effects, uint8_t *wire, size_t *length)

Macro Definition Documentation

FRAME_SGR_PARAMETER_CAPACITY

#define FRAME_SGR_PARAMETER_CAPACITY   16

Definition at line 3 of file frame_validation.c.

Function Documentation

frame_render_contract_decode()

asciichat_error_t frame_render_contract_decode	(	const void *	wire,
		size_t	available,
		acip_render_settings_t *	settings,
		uint32_t *	effects,
		size_t *	length )

Definition at line 209 of file frame_validation.c.

                                                                                  {
  if (!wire || !settings || !effects || !length || available < FRAME_RENDER_CONTRACT_HEADER)
    return SET_ERRNO(ERROR_INVALID_FRAME, "Truncated rendered frame contract");
  uint32_t fields[5];
  memcpy(fields, wire, sizeof(fields));
  for (size_t i = 0; i < 5; ++i)
    fields[i] = NET_TO_HOST_U32(fields[i]);
  if (fields[0] != FRAME_RENDER_CONTRACT_SCHEMA || fields[2] > RENDER_MODE_HALF_BLOCK ||
      (fields[3] & ~(FRAME_RENDER_CONTRACT_RAIN | FRAME_RENDER_CONTRACT_GRID)) || !fields[4] || fields[4] > 255 ||
      fields[4] > available - FRAME_RENDER_CONTRACT_HEADER)
    return SET_ERRNO(ERROR_INVALID_FRAME, "Invalid rendered frame contract schema/mode/effects/palette length");
  memset(settings, 0, sizeof(*settings));
  settings->revision = fields[1];
  settings->caps.render_mode = (terminal_render_mode_t)fields[2];
  settings->palette_length = fields[4];
  memcpy(settings->palette, (const uint8_t *)wire + FRAME_RENDER_CONTRACT_HEADER, fields[4]);
  if (memchr(settings->palette, 0, fields[4]))
    return SET_ERRNO(ERROR_INVALID_FRAME, "Embedded NUL in rendered frame contract palette");
  *effects = fields[3];
  *length = FRAME_RENDER_CONTRACT_HEADER + fields[4];
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, acip_render_settings_t::caps, ERROR_INVALID_FRAME, FRAME_RENDER_CONTRACT_GRID, FRAME_RENDER_CONTRACT_HEADER, FRAME_RENDER_CONTRACT_RAIN, FRAME_RENDER_CONTRACT_SCHEMA, NET_TO_HOST_U32, acip_render_settings_t::palette, acip_render_settings_t::palette_length, acip_render_settings_t::revision, and SET_ERRNO.

Referenced by client_validate_frame().

frame_render_contract_encode()

asciichat_error_t frame_render_contract_encode	(	const acip_render_settings_t *	settings,
		uint32_t	effects,
		uint8_t *	wire,
		size_t *	length )

Definition at line 233 of file frame_validation.c.

                                                               {
  if (!settings || !wire || !length)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Missing rendered frame contract");
  size_t n = strnlen(settings->palette, sizeof(settings->palette));
  if (!n || n > 255)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid rendered frame contract palette");
  uint32_t fields[] = {HOST_TO_NET_U32(FRAME_RENDER_CONTRACT_SCHEMA), HOST_TO_NET_U32(settings->revision),
                       HOST_TO_NET_U32(settings->caps.render_mode), HOST_TO_NET_U32(effects), HOST_TO_NET_U32(n)};
  memcpy(wire, fields, sizeof(fields));
  memcpy(wire + sizeof(fields), settings->palette, n);
  *length = sizeof(fields) + n;
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, acip_render_settings_t::caps, ERROR_INVALID_PARAM, FRAME_RENDER_CONTRACT_SCHEMA, HOST_TO_NET_U32, acip_render_settings_t::palette, acip_render_settings_t::revision, and SET_ERRNO.

Referenced by acip_send_ascii_frame_contract().

session_frame_validate()

asciichat_error_t session_frame_validate	(	const char *	text,
		size_t	length,
		uint32_t	width,
		uint32_t	height )

Definition at line 205 of file frame_validation.c.

                                                                                                           {
  return session_frame_validate_contract(text, length, width, height, NULL, 0);
}

References height, session_frame_validate_contract(), and width.

Referenced by mirror_render_audio_visualization().

session_frame_validate_contract()

asciichat_error_t session_frame_validate_contract	(	const char *	text,
		size_t	length,
		uint32_t	width,
		uint32_t	height,
		const acip_render_settings_t *	settings,
		uint32_t	effects )

Definition at line 193 of file frame_validation.c.

                                                                                                            {
  asciichat_error_t result = validate_contract(text, length, width, height, settings, effects);
  ascii_otel_metric(ASCII_OTEL_METRIC_FRAME_VALIDATION_CHECKED, 1);
  if (result != ASCIICHAT_OK) {
    asciichat_error_context_t error = {0};
    const char *reason = HAS_ERRNO(&error) ? error.context_message : asciichat_error_string(result);
    ascii_otel_frame_rejected("rendered_frame", reason, length, width, height, result);
  }
  return result;
}

References ascii_otel_frame_rejected(), ascii_otel_metric(), ASCIICHAT_OK, asciichat_error_context_t::context_message, HAS_ERRNO, height, and width.

Referenced by client_validate_frame(), mirror_convert_frame(), and session_frame_validate().