presets.c File Reference

Preset option configurations for ascii-chat modes. More...

Go to the source code of this file.

Functions
const options_config_t *	options_preset_binary (const char *program_name, const char *description)
	Get binary-level options preset.
const options_config_t *	options_preset_server (const char *program_name, const char *description)
	Get server mode options preset.
const options_config_t *	options_preset_client (const char *program_name, const char *description)
	Get client mode options preset.
const options_config_t *	options_preset_mirror (const char *program_name, const char *description)
	Get mirror mode options preset.
const options_config_t *	options_preset_acds (const char *program_name, const char *description)
	Get acds mode options preset.

Detailed Description

Preset option configurations for ascii-chat modes.

Definition in file presets.c.

Function Documentation

options_preset_acds()

const options_config_t * options_preset_acds	(	const char *	program_name,
		const char *	description
	)

Get acds mode options preset.

Parameters

program_name	Optional program name (defaults to "ascii-chat acds")
description	Optional program description (defaults to "ASCII Chat Discovery Service")

Returns

Preset config (caller must free after use)

Definition at line 571 of file presets.c.

                                                                                               {
  // Note: Each call creates a new config (no static caching) since program_name/description vary
  options_builder_t *b = options_builder_create(sizeof(options_t));
  if (!b)
    return NULL;
 
  b->program_name = program_name ? program_name : "ascii-chat discovery service";
  b->description = description ? description : "session management and WebRTC signaling";
 
  // Help and version
  options_builder_add_bool(b, "help", 'h', offsetof(options_t, help), false, "Show this help", "GENERAL", false, NULL);
 
  // Network options
  // Note: Bind addresses are specified via positional arguments, not flags
  add_port_option(b, "27225", "ACDS_PORT");
 
  // ACDS-specific options
  options_builder_add_string(b, "key", 'k', offsetof(options_t, acds_key_path), "",
                             "Path to ACDS identity key file (default: ~/.ascii-chat/acds_identity)", "ACDS", false,
                             "ACDS_KEY_PATH", NULL);
 
  options_builder_add_string(b, "database", 'd', offsetof(options_t, acds_database_path), "",
                             "Path to ACDS database file (default: ~/.ascii-chat/acds.db)", "ACDS", false,
                             "ACDS_DATABASE_PATH", NULL);
 
  // Logging options (binary-level, work before or after mode name)
  // Note: ACDS uses partial logging options due to short name conflicts with identity verification options
  options_builder_add_string(b, "log-file", 'L', offsetof(options_t, log_file), "", "Redirect logs to FILE", "LOGGING",
                             false, "ASCII_CHAT_LOG_FILE", NULL);
 
  options_builder_add_callback(b, "log-level", '\0', offsetof(options_t, log_level), &(log_level_t){LOG_INFO},
                               sizeof(log_level_t), parse_log_level,
                               "Set log level: dev, debug, info, warn, error, fatal", "LOGGING", false, NULL);
 
  // Encryption options (shared with client and server)
  options_builder_add_bool(b, "encrypt", 'E', offsetof(options_t, encrypt_enabled), false, "Enable encryption",
                           "SECURITY", false, NULL);
 
  options_builder_add_string(b, "key", 'K', offsetof(options_t, encrypt_key), "", "SSH/GPG key file path", "SECURITY",
                             false, "ASCII_CHAT_KEY", NULL);
 
  options_builder_add_string(b, "password", '\0', offsetof(options_t, password), "",
                             "Shared password for authentication", "SECURITY", false, "ASCII_CHAT_PASSWORD", NULL);
 
  options_builder_add_string(b, "keyfile", 'F', offsetof(options_t, encrypt_keyfile), "", "Alternative key file path",
                             "SECURITY", false, NULL, NULL);
 
  options_builder_add_bool(b, "no-encrypt", '\0', offsetof(options_t, no_encrypt), false, "Disable encryption",
                           "SECURITY", false, NULL);
 
  // Identity verification options
  options_builder_add_bool(b, "require-server-identity", 'S', offsetof(options_t, require_server_identity), false,
                           "Require servers to provide signed Ed25519 identity when creating sessions", "SECURITY",
                           false, NULL);
 
  options_builder_add_bool(b, "require-client-identity", 'C', offsetof(options_t, require_client_identity), false,
                           "Require clients to provide signed Ed25519 identity when joining sessions", "SECURITY",
                           false, NULL);
 
  options_builder_add_bool(b, "require-server-verify", 'V', offsetof(options_t, require_server_verify), false,
                           "ACDS policy: require servers to verify client identity during handshake", "SECURITY", false,
                           NULL);
 
  options_builder_add_bool(b, "require-client-verify", 'c', offsetof(options_t, require_client_verify), false,
                           "ACDS policy: require clients to verify server identity during handshake", "SECURITY", false,
                           NULL);
 
  // WebRTC connectivity options
  options_builder_add_string(b, "stun-servers", '\0', offsetof(options_t, stun_servers),
                             "stun:stun.ascii-chat.com:3478,stun:stun.l.google.com:19302",
                             "Comma-separated list of STUN server URLs", "WEBRTC", false, "ASCII_CHAT_STUN_SERVERS",
                             NULL);
 
  options_builder_add_string(b, "turn-servers", '\0', offsetof(options_t, turn_servers),
                             "turn:turn.ascii-chat.com:3478", "Comma-separated list of TURN server URLs", "WEBRTC",
                             false, "ASCII_CHAT_TURN_SERVERS", NULL);
 
  options_builder_add_string(b, "turn-username", '\0', offsetof(options_t, turn_username), "ascii",
                             "Username for TURN server authentication", "WEBRTC", false, "ASCII_CHAT_TURN_USERNAME",
                             NULL);
 
  options_builder_add_string(b, "turn-credential", '\0', offsetof(options_t, turn_credential),
                             "0aa9917b4dad1b01631e87a32b875e09", "Credential/password for TURN server authentication",
                             "WEBRTC", false, "ASCII_CHAT_TURN_CREDENTIAL", NULL);
 
  options_builder_add_string(b, "turn-secret", '\0', offsetof(options_t, turn_secret), "",
                             "Shared secret for dynamic TURN credential generation (HMAC-SHA1)", "WEBRTC", false,
                             "ASCII_CHAT_TURN_SECRET", NULL);
 
  options_builder_add_bool(b, "upnp", '\0', offsetof(options_t, enable_upnp), true,
                           "Enable UPnP/NAT-PMP for automatic port mapping (enables direct TCP for most home users)",
                           "WEBRTC", false, "ASCII_CHAT_UPNP");
 
  options_builder_add_bool(b, "no-upnp", '\0', offsetof(options_t, no_upnp), false,
                           "Disable UPnP/NAT-PMP port mapping (requires manual port forwarding)", "WEBRTC", false,
                           NULL);
 
  // Action options (execute and exit)
  options_builder_add_action(b, "version", 'v', action_show_version, "Show version information and exit", "ACTIONS");
 
  // Positional arguments: 0-2 bind addresses (IPv4 and/or IPv6)
  options_builder_add_positional(b, "bind-address", "IPv4 or IPv6 bind address (can specify 0-2 addresses)",
                                 false, // Not required (defaults to localhost)
                                 "BIND ADDRESS FORMATS", g_server_bind_address_examples,
                                 sizeof(g_server_bind_address_examples) / sizeof(g_server_bind_address_examples[0]),
                                 parse_server_bind_address);
 
  const options_config_t *config = options_builder_build(b);
  options_builder_destroy(b);
  return config;
}

References action_show_version(), options_builder_t::description, log_file, LOG_INFO, options_builder_add_action(), options_builder_add_bool(), options_builder_add_callback(), options_builder_add_positional(), options_builder_add_string(), options_builder_build(), options_builder_create(), options_builder_destroy(), parse_log_level(), parse_server_bind_address(), and options_builder_t::program_name.

Referenced by parse_acds_options(), and usage_acds().

options_preset_binary()

const options_config_t * options_preset_binary	(	const char *	program_name,
		const char *	description
	)

Get binary-level options preset.

Binary options are parsed BEFORE mode selection. Includes: –help, –version, –log-file, –log-level, etc.

Parameters

program_name	Optional program name (defaults to "ascii-chat")
description	Optional program description

Returns

Preset config (caller must free after use)

Definition at line 273 of file presets.c.

                                                                                                 {
  // Note: Each call creates a new config (no static caching) since program_name/description vary
  options_builder_t *b = options_builder_create(sizeof(options_t));
  if (!b)
    return NULL;
 
  b->program_name = program_name ? program_name : "ascii-chat";
  b->description = description ? description : "Video chat in your terminal";
 
  // Help and version
  options_builder_add_bool(b, "help", '\0', offsetof(options_t, help), false, "Show this help", "GENERAL", false, NULL);
 
  options_builder_add_bool(b, "version", '\0', offsetof(options_t, version), false, "Show version information",
                           "GENERAL", false, NULL);
 
  // Add logging options
  add_binary_logging_options(b);
 
  const options_config_t *config = options_builder_build(b);
  options_builder_destroy(b);
  return config;
}

References options_builder_t::description, options_builder_add_bool(), options_builder_build(), options_builder_create(), options_builder_destroy(), and options_builder_t::program_name.

options_preset_client()

const options_config_t * options_preset_client	(	const char *	program_name,
		const char *	description
	)

Get client mode options preset.

Parameters

program_name	Optional program name (defaults to "ascii-chat client")
description	Optional program description (defaults to "Connect to ascii-chat server")

Returns

Preset config (caller must free after use)

Definition at line 398 of file presets.c.

                                                                                                 {
  // Note: Each call creates a new config (no static caching) since program_name/description vary
  options_builder_t *b = options_builder_create(sizeof(options_t));
  if (!b)
    return NULL;
 
  b->program_name = program_name ? program_name : "ascii-chat client";
  b->description = description ? description : "Connect to ascii-chat server";
 
  // Network options
  // Note: Server address and port are specified via positional argument [address][:port], not flags
  add_port_option(b, OPT_PORT_DEFAULT, "ASCII_CHAT_PORT");
 
  options_builder_add_int(b, "reconnect", 'r', offsetof(options_t, reconnect_attempts), OPT_RECONNECT_ATTEMPTS_DEFAULT,
                          "Reconnection attempts (-1=infinite)", "NETWORK", false, NULL, NULL);
 
  options_builder_add_bool(b, "scan", '\0', offsetof(options_t, lan_discovery), false,
                           "Scan for ASCII-Chat servers on local network (mDNS)", "NETWORK", false, NULL);
 
  // Terminal dimensions, webcam, display, and snapshot options (shared with mirror)
  add_terminal_dimension_options(b);
  add_webcam_options(b);
  add_display_options(b);
  add_snapshot_options(b);
 
  // Audio options
  options_builder_add_bool(b, "audio", 'A', offsetof(options_t, audio_enabled), false, "Enable audio streaming",
                           "AUDIO", false, NULL);
 
  options_builder_add_int(b, "microphone-index", '\0', offsetof(options_t, microphone_index),
                          OPT_MICROPHONE_INDEX_DEFAULT, "Microphone device index (-1=default)", "AUDIO", false, NULL,
                          NULL);
 
  options_builder_add_int(b, "speakers-index", '\0', offsetof(options_t, speakers_index), OPT_SPEAKERS_INDEX_DEFAULT,
                          "Speakers device index (-1=default)", "AUDIO", false, NULL, NULL);
 
  options_builder_add_bool(b, "audio-analysis", '\0', offsetof(options_t, audio_analysis_enabled), false,
                           "Enable audio analysis (debug)", "AUDIO", false, NULL);
 
  options_builder_add_bool(b, "no-audio-playback", '\0', offsetof(options_t, audio_no_playback), false,
                           "Disable speaker playback (debug)", "AUDIO", false, NULL);
 
  // Compression and audio encoding options (shared with server)
  add_compression_options(b);
 
  // ACDS Discovery options (shared with server)
  add_acds_discovery_options(b);
 
  // WebRTC Connection Strategy Options (Phase 3 fallback control)
  options_builder_add_bool(b, "prefer-webrtc", '\0', offsetof(options_t, prefer_webrtc), false,
                           "Try WebRTC before Direct TCP (useful when Direct TCP fails)", "NETWORK", false, NULL);
 
  options_builder_add_bool(b, "no-webrtc", '\0', offsetof(options_t, no_webrtc), false,
                           "Disable WebRTC, use Direct TCP only", "NETWORK", false, NULL);
 
  options_builder_add_bool(b, "webrtc-skip-stun", '\0', offsetof(options_t, webrtc_skip_stun), false,
                           "Skip WebRTC+STUN stage, go straight to TURN relay", "NETWORK", false, NULL);
 
  options_builder_add_bool(b, "webrtc-disable-turn", '\0', offsetof(options_t, webrtc_disable_turn), false,
                           "Disable WebRTC+TURN relay, use STUN only", "NETWORK", false, NULL);
 
  // WebRTC Server Configuration (for testing/debugging - production uses ACDS)
  // Note: In production, ACDS provides these automatically via SESSION_JOINED response
  options_builder_add_string(b, "stun-servers", '\0', offsetof(options_t, stun_servers), "",
                             "Comma-separated STUN server URLs (debug/test only - ACDS provides in production)",
                             "WEBRTC", false, "ASCII_CHAT_STUN_SERVERS", NULL);
 
  options_builder_add_string(b, "turn-servers", '\0', offsetof(options_t, turn_servers), "",
                             "Comma-separated TURN server URLs (debug/test only - ACDS provides in production)",
                             "WEBRTC", false, "ASCII_CHAT_TURN_SERVERS", NULL);
 
  options_builder_add_string(b, "turn-username", '\0', offsetof(options_t, turn_username), "",
                             "TURN authentication username (debug/test only - ACDS provides in production)", "WEBRTC",
                             false, "ASCII_CHAT_TURN_USERNAME", NULL);
 
  options_builder_add_string(b, "turn-credential", '\0', offsetof(options_t, turn_credential), "",
                             "TURN authentication credential (debug/test only - ACDS provides in production)", "WEBRTC",
                             false, "ASCII_CHAT_TURN_CREDENTIAL", NULL);
 
  // Security options (common with server, plus client-specific server-key)
  add_crypto_common_options(b);
 
  options_builder_add_string(b, "server-key", '\0', offsetof(options_t, server_key), "", "Expected server public key",
                             "SECURITY", false, NULL, NULL);
 
  options_builder_add_bool(b, "acds-insecure", '\0', offsetof(options_t, acds_insecure), false,
                           "Skip server key verification (MITM-vulnerable, requires explicit opt-in)", "SECURITY",
                           false, NULL);
 
  // Add binary-level logging options (--log-file, --log-level, -V, -q)
  // These work before or after the mode name
  add_binary_logging_options(b);
 
  // Dependencies
  options_builder_add_dependency_requires(b, "snapshot-delay", "snapshot",
                                          "Option --snapshot-delay requires --snapshot");
  options_builder_add_dependency_conflicts(b, "no-compress", "compression-level",
                                           "Cannot use --no-compress with --compression-level");
  options_builder_add_dependency_conflicts(b, "encode-audio", "no-encode-audio",
                                           "Cannot use both --encode-audio and --no-encode-audio");
 
  // Action options (execute and exit)
  options_builder_add_action(b, "help", 'h', action_help_client, "Show this help message and exit", "ACTIONS");
 
  options_builder_add_action(b, "list-webcams", '\0', action_list_webcams, "List available webcam devices and exit",
                             "ACTIONS");
 
  options_builder_add_action(b, "list-microphones", '\0', action_list_microphones,
                             "List available microphone devices and exit", "ACTIONS");
 
  options_builder_add_action(b, "list-speakers", '\0', action_list_speakers, "List available speaker devices and exit",
                             "ACTIONS");
 
  options_builder_add_action(b, "show-capabilities", '\0', action_show_capabilities,
                             "Show terminal capabilities and exit", "ACTIONS");
 
  // Positional argument: [address][:port]
  options_builder_add_positional(
      b, "address", "[address][:port] - Server address (IPv4, IPv6, or hostname) with optional port",
      false, // Not required (defaults to localhost:27224)
      "ADDRESS FORMATS", g_client_address_examples,
      sizeof(g_client_address_examples) / sizeof(g_client_address_examples[0]), parse_client_address);
 
  const options_config_t *config = options_builder_build(b);
  options_builder_destroy(b);
  return config;
}

References action_help_client(), action_list_microphones(), action_list_speakers(), action_list_webcams(), action_show_capabilities(), options_builder_t::description, OPT_MICROPHONE_INDEX_DEFAULT, OPT_PORT_DEFAULT, OPT_RECONNECT_ATTEMPTS_DEFAULT, OPT_SPEAKERS_INDEX_DEFAULT, options_builder_add_action(), options_builder_add_bool(), options_builder_add_dependency_conflicts(), options_builder_add_dependency_requires(), options_builder_add_int(), options_builder_add_positional(), options_builder_add_string(), options_builder_build(), options_builder_create(), options_builder_destroy(), parse_client_address(), and options_builder_t::program_name.

Referenced by parse_client_options(), and usage_client().

options_preset_mirror()

const options_config_t * options_preset_mirror	(	const char *	program_name,
		const char *	description
	)

Get mirror mode options preset.

Parameters

program_name	Optional program name (defaults to "ascii-chat mirror")
description	Optional program description (defaults to "Local webcam viewing (no network)")

Returns

Preset config (caller must free after use)

Definition at line 530 of file presets.c.

                                                                                                 {
  // Note: Each call creates a new config (no static caching) since program_name/description vary
  options_builder_t *b = options_builder_create(sizeof(options_t));
  if (!b)
    return NULL;
 
  b->program_name = program_name ? program_name : "ascii-chat mirror";
  b->description = description ? description : "Local webcam viewing (no network)";
 
  // Terminal dimensions, webcam, display, and snapshot options (shared with client)
  add_terminal_dimension_options(b);
  add_webcam_options(b);
  add_display_options(b);
  add_snapshot_options(b);
 
  // Add binary-level logging options (--log-file, --log-level, -V, -q)
  // These work before or after the mode name
  add_binary_logging_options(b);
 
  // Dependencies
  options_builder_add_dependency_requires(b, "snapshot-delay", "snapshot",
                                          "Option --snapshot-delay requires --snapshot");
 
  // Action options (execute and exit)
  options_builder_add_action(b, "help", 'h', action_help_mirror, "Show this help message and exit", "ACTIONS");
 
  options_builder_add_action(b, "list-webcams", '\0', action_list_webcams, "List available webcam devices and exit",
                             "ACTIONS");
 
  options_builder_add_action(b, "show-capabilities", '\0', action_show_capabilities,
                             "Show terminal capabilities and exit", "ACTIONS");
 
  const options_config_t *config = options_builder_build(b);
  options_builder_destroy(b);
  return config;
}

References action_help_mirror(), action_list_webcams(), action_show_capabilities(), options_builder_t::description, options_builder_add_action(), options_builder_add_dependency_requires(), options_builder_build(), options_builder_create(), options_builder_destroy(), and options_builder_t::program_name.

Referenced by parse_mirror_options(), and usage_mirror().

options_preset_server()

const options_config_t * options_preset_server	(	const char *	program_name,
		const char *	description
	)

Get server mode options preset.

Parameters

program_name	Optional program name (defaults to "ascii-chat server")
description	Optional program description (defaults to "Start ascii-chat server")

Returns

Preset config (caller must free after use)

Definition at line 300 of file presets.c.

                                                                                                 {
  // Note: Each call creates a new config (no static caching) since program_name/description vary
  options_builder_t *b = options_builder_create(sizeof(options_t));
  if (!b)
    return NULL;
 
  b->program_name = program_name ? program_name : "ascii-chat server";
  b->description = description ? description : "Start ascii-chat server";
 
  // Network options
  // Note: Server bind addresses are positional arguments only, not flags
  add_port_option(b, OPT_PORT_DEFAULT, "ASCII_CHAT_PORT");
 
  options_builder_add_int(b, "max-clients", '\0', offsetof(options_t, max_clients), OPT_MAX_CLIENTS_DEFAULT,
                          "Maximum concurrent clients", "NETWORK", false, "ASCII_CHAT_MAX_CLIENTS", NULL);
 
  // Compression and audio encoding options (shared with client)
  add_compression_options(b);
 
  options_builder_add_bool(b, "no-audio-mixer", '\0', offsetof(options_t, no_audio_mixer), false,
                           "Disable audio mixer (debug)", "PERFORMANCE", false, NULL);
 
  // Security options (common with client, plus server-specific client-keys and no-encrypt)
  add_crypto_common_options(b);
 
  options_builder_add_string(b, "client-keys", '\0', offsetof(options_t, client_keys), "",
                             "Allowed client keys whitelist", "SECURITY", false, NULL, NULL);
 
  options_builder_add_bool(b, "acds-expose-ip", '\0', offsetof(options_t, acds_expose_ip), false,
                           "Explicitly allow public IP disclosure in ACDS sessions (requires ACDS, opt-in only)",
                           "SECURITY", false, NULL);
 
  options_builder_add_bool(b, "no-encrypt", '\0', offsetof(options_t, no_encrypt), false, "Disable encryption",
                           "SECURITY", false, NULL);
 
  // ACDS Session Registration
  options_builder_add_bool(b, "acds", '\0', offsetof(options_t, acds), false,
                           "Enable ACDS session registration (requires --key or --password or --acds-expose-ip)",
                           "DISCOVERY", false, NULL);
 
  // ACDS Discovery options (shared with client)
  add_acds_discovery_options(b);
 
  options_builder_add_bool(b, "upnp", '\0', offsetof(options_t, enable_upnp), true,
                           "Enable UPnP/NAT-PMP for automatic port mapping (enables direct TCP for most home users)",
                           "DISCOVERY", false, "ASCII_CHAT_UPNP");
 
  options_builder_add_bool(b, "no-upnp", '\0', offsetof(options_t, no_upnp), false,
                           "Disable UPnP/NAT-PMP port mapping (requires manual port forwarding)", "DISCOVERY", false,
                           NULL);
 
  options_builder_add_bool(b, "no-mdns-advertise", '\0', offsetof(options_t, no_mdns_advertise), false,
                           "Disable mDNS service advertisement on local network (LAN discovery won't find this server)",
                           "DISCOVERY", false, NULL);
 
  // Add binary-level logging options (--log-file, --log-level, -V, -q)
  // These work before or after the mode name
  add_binary_logging_options(b);
 
  // Dependencies
  options_builder_add_dependency_conflicts(b, "no-encrypt", "encrypt", "Cannot use --no-encrypt with --encrypt");
  options_builder_add_dependency_conflicts(b, "no-encrypt", "key", "Cannot use --no-encrypt with --key");
  options_builder_add_dependency_conflicts(b, "no-encrypt", "password", "Cannot use --no-encrypt with --password");
  options_builder_add_dependency_conflicts(b, "no-compress", "compression-level",
                                           "Cannot use --no-compress with --compression-level");
  options_builder_add_dependency_conflicts(b, "encode-audio", "no-encode-audio",
                                           "Cannot use both --encode-audio and --no-encode-audio");
 
  // Action options (execute and exit)
  options_builder_add_action(b, "help", 'h', action_help_server, "Show this help message and exit", "ACTIONS");
 
  options_builder_add_action(b, "list-webcams", '\0', action_list_webcams, "List available webcam devices and exit",
                             "ACTIONS");
 
  options_builder_add_action(b, "list-microphones", '\0', action_list_microphones,
                             "List available microphone devices and exit", "ACTIONS");
 
  options_builder_add_action(b, "list-speakers", '\0', action_list_speakers, "List available speaker devices and exit",
                             "ACTIONS");
 
  options_builder_add_action(b, "version", 'V', action_show_version, "Show version information and exit", "ACTIONS");
 
  // Positional arguments: 0-2 bind addresses (IPv4 and/or IPv6)
  options_builder_add_positional(b, "bind-address", "IPv4 or IPv6 bind address (can specify 0-2 addresses)",
                                 false, // Not required (defaults to localhost)
                                 "BIND ADDRESS FORMATS", g_server_bind_address_examples,
                                 sizeof(g_server_bind_address_examples) / sizeof(g_server_bind_address_examples[0]),
                                 parse_server_bind_address);
 
  const options_config_t *config = options_builder_build(b);
  options_builder_destroy(b);
  return config;
}

References action_help_server(), action_list_microphones(), action_list_speakers(), action_list_webcams(), action_show_version(), options_builder_t::description, OPT_MAX_CLIENTS_DEFAULT, OPT_PORT_DEFAULT, options_builder_add_action(), options_builder_add_bool(), options_builder_add_dependency_conflicts(), options_builder_add_int(), options_builder_add_positional(), options_builder_add_string(), options_builder_build(), options_builder_create(), options_builder_destroy(), parse_server_bind_address(), and options_builder_t::program_name.

Referenced by parse_server_options(), and usage_server().