render_contract.h File Reference

Go to the source code of this file.

Macros
#define	FRAME_RENDER_MAX_BYTES   (16u * 1024u * 1024u)
#define	FRAME_RENDER_CONTRACT_SCHEMA   1u
#define	FRAME_RENDER_CONTRACT_HEADER   20u
#define	FRAME_RENDER_CONTRACT_MAX   (FRAME_RENDER_CONTRACT_HEADER + 255u)
#define	FRAME_RENDER_CONTRACT_RAIN   1u
#define	FRAME_RENDER_CONTRACT_GRID   2u

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

Macro Definition Documentation

FRAME_RENDER_CONTRACT_GRID

#define FRAME_RENDER_CONTRACT_GRID   2u

Definition at line 14 of file render_contract.h.

Referenced by frame_render_contract_decode().

FRAME_RENDER_CONTRACT_HEADER

#define FRAME_RENDER_CONTRACT_HEADER   20u

Definition at line 11 of file render_contract.h.

Referenced by frame_render_contract_decode().

FRAME_RENDER_CONTRACT_MAX

#define FRAME_RENDER_CONTRACT_MAX   (FRAME_RENDER_CONTRACT_HEADER + 255u)

Definition at line 12 of file render_contract.h.

Referenced by acip_send_ascii_frame_contract().

FRAME_RENDER_CONTRACT_RAIN

#define FRAME_RENDER_CONTRACT_RAIN   1u

Definition at line 13 of file render_contract.h.

Referenced by frame_render_contract_decode(), mirror_convert_frame(), and server_send_video().

FRAME_RENDER_CONTRACT_SCHEMA

#define FRAME_RENDER_CONTRACT_SCHEMA   1u

Definition at line 10 of file render_contract.h.

Referenced by frame_render_contract_decode(), and frame_render_contract_encode().

FRAME_RENDER_MAX_BYTES

#define FRAME_RENDER_MAX_BYTES   (16u * 1024u * 1024u)

Definition at line 9 of file render_contract.h.

Referenced by client_decode_frame_data(), and client_validate_frame().

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().