ascii-chat 0.6.0
Real-time terminal-based video chat with ASCII art conversion
Loading...
Searching...
No Matches
options/common.h
Go to the documentation of this file.
1
26#pragma once
27
28#include "options/options.h"
29#include <getopt.h>
30#include <stdbool.h>
31#include <stddef.h>
32#include <stdint.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38// ============================================================================
39// Option Parsing Helpers
40// ============================================================================
41
62const char *find_similar_option(const char *unknown_opt, const struct option *options);
63
84int strtoint_safe(const char *str);
85
94static inline asciichat_error_t option_error_invalid(void) {
95 return ERROR_INVALID_PARAM;
96}
97
122char *validate_required_argument(const char *optarg, char *argbuf, size_t argbuf_size, const char *option_name,
123 asciichat_mode_t mode);
124
144bool validate_positive_int_opt(const char *value_str, int *out_value, const char *param_name);
145
165bool validate_port_opt(const char *value_str, uint16_t *out_port);
166
186bool validate_fps_opt(const char *value_str, int *out_fps);
187
207bool validate_webcam_index(const char *value_str, unsigned short int *out_index);
208
231asciichat_error_t detect_default_ssh_key(char *key_path, size_t path_size);
232
233// ============================================================================
234// Argument Processing Helpers
235// ============================================================================
236
258char *strip_equals_prefix(const char *opt_value, char *buffer, size_t buffer_size);
259
291char *get_required_argument(const char *opt_value, char *buffer, size_t buffer_size, const char *option_name,
292 asciichat_mode_t mode);
293
305char *read_password_from_stdin(const char *prompt);
306
307// ============================================================================
308// Shared Option Parsers (Client + Mirror Common Options)
309// ============================================================================
310
324asciichat_error_t parse_color_mode_option(const char *value_str, options_t *opts);
325
339asciichat_error_t parse_render_mode_option(const char *value_str, options_t *opts);
340
353asciichat_error_t parse_palette_option(const char *value_str, options_t *opts);
354
368asciichat_error_t parse_palette_chars_option(const char *value_str, options_t *opts);
369
382asciichat_error_t parse_width_option(const char *value_str, options_t *opts);
383
396asciichat_error_t parse_height_option(const char *value_str, options_t *opts);
397
410asciichat_error_t parse_webcam_index_option(const char *value_str, options_t *opts);
411
424asciichat_error_t parse_snapshot_delay_option(const char *value_str, options_t *opts);
425
439asciichat_error_t parse_log_level_option(const char *value_str, options_t *opts);
440
441// ============================================================================
442// Terminal Dimension Utilities
443// ============================================================================
444
468void update_dimensions_for_full_height(options_t *opts);
469
491void update_dimensions_to_terminal_size(options_t *opts);
492
493// ============================================================================
494// Usage String Macros (Complete Format Strings)
495// ============================================================================
496
497// Formatting
498#define USAGE_INDENT " "
499
500// Common Options
501#define USAGE_HELP_LINE USAGE_INDENT "-h --help " USAGE_INDENT "print this help\n"
502#define USAGE_VERSION_LINE USAGE_INDENT "-v --version " USAGE_INDENT "print version information\n"
503
504// Network Options
505#define USAGE_PORT_LINE \
506 USAGE_INDENT "-p --port PORT " USAGE_INDENT "TCP port to listen on (default: %d)\n"
507#define USAGE_PORT_CLIENT_LINE \
508 USAGE_INDENT "-p --port PORT " USAGE_INDENT "override port from address (default: 27224)\n"
509#define USAGE_RECONNECT_LINE \
510 USAGE_INDENT " --reconnect VALUE " USAGE_INDENT \
511 "reconnection behavior: off, auto, or 1-999 (default: auto)\n"
512
513// Server Options
514#define USAGE_MAX_CLIENTS_LINE \
515 USAGE_INDENT " --max-clients N " USAGE_INDENT "maximum simultaneous clients (1-9, default: 9)\n"
516#define USAGE_NO_AUDIO_MIXER_LINE \
517 USAGE_INDENT " --no-audio-mixer " USAGE_INDENT "disable audio mixer - send silence (debug mode only)\n"
518
519// Terminal Dimensions
520#define USAGE_WIDTH_LINE \
521 USAGE_INDENT "-x --width WIDTH " USAGE_INDENT "render width (default: [auto-set])\n"
522#define USAGE_HEIGHT_LINE \
523 USAGE_INDENT "-y --height HEIGHT " USAGE_INDENT "render height (default: [auto-set])\n"
524
525// Webcam Options
526#define USAGE_WEBCAM_INDEX_LINE \
527 USAGE_INDENT "-c --webcam-index CAMERA " USAGE_INDENT "webcam device index (0-based) (default: 0)\n"
528#define USAGE_LIST_WEBCAMS_LINE \
529 USAGE_INDENT " --list-webcams " USAGE_INDENT "list available webcam devices and exit\n"
530#define USAGE_WEBCAM_FLIP_LINE \
531 USAGE_INDENT "-f --webcam-flip " USAGE_INDENT \
532 "toggle horizontal flip of webcam image (default: flipped)\n"
533#define USAGE_TEST_PATTERN_CLIENT_LINE \
534 USAGE_INDENT " --test-pattern " USAGE_INDENT \
535 "use test pattern instead of webcam (for testing multiple clients)\n"
536#define USAGE_TEST_PATTERN_MIRROR_LINE \
537 USAGE_INDENT " --test-pattern " USAGE_INDENT "use test pattern instead of webcam (for testing)\n"
538
539// Display Options (platform-specific FPS handled separately)
540#define USAGE_FPS_WIN_LINE \
541 USAGE_INDENT " --fps FPS " USAGE_INDENT "desired frame rate 1-144 (default: 30 for Windows)\n"
542#define USAGE_FPS_UNIX_LINE \
543 USAGE_INDENT " --fps FPS " USAGE_INDENT "desired frame rate 1-144 (default: 60 for Unix)\n"
544#define USAGE_COLOR_MODE_LINE \
545 USAGE_INDENT " --color-mode MODE " USAGE_INDENT \
546 "color modes: auto, none, 16, 256, truecolor (default: auto)\n"
547#define USAGE_SHOW_CAPABILITIES_LINE \
548 USAGE_INDENT " --show-capabilities " USAGE_INDENT "show detected terminal capabilities and exit\n"
549#define USAGE_UTF8_LINE \
550 USAGE_INDENT " --utf8 " USAGE_INDENT "force enable UTF-8/Unicode support (default: [unset])\n"
551#define USAGE_RENDER_MODE_LINE \
552 USAGE_INDENT "-M --render-mode MODE " USAGE_INDENT \
553 "Rendering modes: foreground, background, half-block (default: foreground)\n"
554#define USAGE_PALETTE_LINE \
555 USAGE_INDENT "-P --palette PALETTE " USAGE_INDENT \
556 "ASCII character palette: standard, blocks, digital, minimal, cool, custom (default: standard)\n"
557#define USAGE_PALETTE_CHARS_LINE \
558 USAGE_INDENT "-C --palette-chars CHARS " USAGE_INDENT \
559 "Custom palette characters (implies --palette=custom) (default: [unset])\n"
560#define USAGE_STRETCH_LINE \
561 USAGE_INDENT "-s --stretch " USAGE_INDENT \
562 "stretch or shrink video to fit (ignore aspect ratio) (default: [unset])\n"
563
564// Snapshot Options
565#define USAGE_SNAPSHOT_LINE \
566 USAGE_INDENT "-S --snapshot " USAGE_INDENT "capture single frame and exit (default: [unset])\n"
567#define USAGE_SNAPSHOT_DELAY_LINE \
568 USAGE_INDENT "-D --snapshot-delay SECONDS " USAGE_INDENT "delay SECONDS before snapshot (default: %.1f)\n"
569#define USAGE_STRIP_ANSI_LINE \
570 USAGE_INDENT " --strip-ansi " USAGE_INDENT \
571 "remove all ANSI escape codes from output (default: [unset])\n"
572
573// Audio Options
574#define USAGE_AUDIO_LINE \
575 USAGE_INDENT "-A --audio " USAGE_INDENT "enable audio capture and playback (default: [unset])\n"
576#define USAGE_AUDIO_ANALYSIS_LINE \
577 USAGE_INDENT " --audio-analysis " USAGE_INDENT \
578 "track and report audio quality metrics (with --audio) (default: [unset])\n"
579#define USAGE_NO_AUDIO_PLAYBACK_LINE \
580 USAGE_INDENT " --no-audio-playback " USAGE_INDENT \
581 "disable speaker playback but keep recording received audio (debug mode) (default: [unset])\n"
582#define USAGE_LIST_MICROPHONES_LINE \
583 USAGE_INDENT " --list-microphones " USAGE_INDENT "list available audio input devices and exit\n"
584#define USAGE_LIST_SPEAKERS_LINE \
585 USAGE_INDENT " --list-speakers " USAGE_INDENT "list available audio output devices and exit\n"
586#define USAGE_MICROPHONE_INDEX_LINE \
587 USAGE_INDENT " --microphone-index INDEX " USAGE_INDENT "microphone device index (-1 for default) (default: -1)\n"
588#define USAGE_SPEAKERS_INDEX_LINE \
589 USAGE_INDENT " --speakers-index INDEX " USAGE_INDENT "speakers device index (-1 for default) (default: -1)\n"
590
591// Encryption Options
592#define USAGE_ENCRYPT_LINE \
593 USAGE_INDENT "-E --encrypt " USAGE_INDENT "enable packet encryption (default: [unset])\n"
594#define USAGE_KEY_SERVER_LINE \
595 USAGE_INDENT "-K --key KEY " USAGE_INDENT \
596 "SSH/GPG key file for authentication: /path/to/key, gpg:keyid, github:user, gitlab:user, or 'ssh' " \
597 "(implies --encrypt) (default: [unset])\n"
598#define USAGE_KEY_CLIENT_LINE \
599 USAGE_INDENT "-K --key KEY " USAGE_INDENT \
600 "SSH/GPG key file for authentication: /path/to/key, gpg:keyid, github:user, gitlab:user, or 'ssh' for " \
601 "auto-detect (implies --encrypt) (default: [unset])\n"
602#define USAGE_PASSWORD_LINE \
603 USAGE_INDENT " --password [PASS] " USAGE_INDENT \
604 "password for connection encryption (prompts if not provided) (implies --encrypt) (default: [unset])\n"
605#define USAGE_KEYFILE_LINE \
606 USAGE_INDENT "-F --keyfile FILE " USAGE_INDENT \
607 "read encryption key from FILE (implies --encrypt) (default: [unset])\n"
608#define USAGE_NO_ENCRYPT_LINE \
609 USAGE_INDENT " --no-encrypt " USAGE_INDENT "disable encryption (default: [unset])\n"
610#define USAGE_SERVER_KEY_LINE \
611 USAGE_INDENT " --server-key KEY " USAGE_INDENT \
612 "expected server public key for verification (default: [unset])\n"
613#define USAGE_CLIENT_KEYS_LINE \
614 USAGE_INDENT " --client-keys KEYS" USAGE_INDENT \
615 "allowed client public keys (comma-separated, supports github:user, gitlab:user, gpg:keyid, or SSH " \
616 "pubkey) (default: [unset])\n"
617
618// Compression Options
619#define USAGE_COMPRESSION_LEVEL_LINE \
620 USAGE_INDENT " --compression-level N " USAGE_INDENT "zstd compression level 1-9 (default: 1)\n"
621#define USAGE_NO_COMPRESS_LINE \
622 USAGE_INDENT " --no-compress " USAGE_INDENT "disable frame compression (default: [unset])\n"
623#define USAGE_ENCODE_AUDIO_LINE \
624 USAGE_INDENT " --encode-audio " USAGE_INDENT "enable Opus audio encoding (default: enabled)\n"
625#define USAGE_NO_ENCODE_AUDIO_LINE USAGE_INDENT " --no-encode-audio " USAGE_INDENT "disable Opus audio encoding\n"
626
627// ACDS Options
628#ifdef _WIN32
629#define USAGE_DATABASE_LINE \
630 USAGE_INDENT "-d --db PATH " USAGE_INDENT \
631 "SQLite database path (default: %APPDATA%\\ascii-chat\\acds.db)\n"
632#else
633#define USAGE_DATABASE_LINE \
634 USAGE_INDENT "-d --db PATH " USAGE_INDENT \
635 "SQLite database path (default: ~/.config/ascii-chat/acds.db)\n"
636#endif
637#define USAGE_LOG_FILE_LINE USAGE_INDENT "-L --log-file FILE " USAGE_INDENT "log file path (default: stderr)\n"
638#define USAGE_LOG_LEVEL_LINE \
639 USAGE_INDENT "-l --log-level LEVEL " USAGE_INDENT \
640 "log level: dev, debug, info, warn, error, fatal (default: info)\n"
641
642#ifdef __cplusplus
643}
644#endif
uint16_t
unsigned short uint16_t
Definition common.h:57
asciichat_error_t
asciichat_error_t
Error and exit codes - unified status values (0-255)
Definition error_codes.h:46
ERROR_INVALID_PARAM
@ ERROR_INVALID_PARAM
Definition error_codes.h:101
asciichat_mode_t
asciichat_mode_t
Mode type for options parsing.
Definition options.h:426
strip_equals_prefix
char * strip_equals_prefix(const char *opt_value, char *buffer, size_t buffer_size)
Strip equals sign prefix from option argument.
Definition options/common.c:195
validate_required_argument
char * validate_required_argument(const char *optarg, char *argbuf, size_t argbuf_size, const char *option_name, asciichat_mode_t mode)
Validate and retrieve required argument for an option.
Definition options/common.c:86
find_similar_option
const char * find_similar_option(const char *unknown_opt, const struct option *options)
Find a similar option name for typo suggestions.
Definition options/common.c:42
parse_render_mode_option
asciichat_error_t parse_render_mode_option(const char *value_str, options_t *opts)
Parse –render-mode option and set opts->render_mode.
Definition options/common.c:384
strtoint_safe
int strtoint_safe(const char *str)
Safely parse string to integer with validation.
Definition options/common.c:67
update_dimensions_to_terminal_size
void update_dimensions_to_terminal_size(options_t *opts)
Update dimensions to current terminal size.
Definition options/common.c:564
parse_width_option
asciichat_error_t parse_width_option(const char *value_str, options_t *opts)
Parse –width option and set opts->width.
Definition options/common.c:449
detect_default_ssh_key
asciichat_error_t detect_default_ssh_key(char *key_path, size_t path_size)
Detect default SSH key path for the current user.
Definition options/common.c:165
read_password_from_stdin
char * read_password_from_stdin(const char *prompt)
Read password from stdin with prompt.
Definition options/common.c:244
validate_port_opt
bool validate_port_opt(const char *value_str, uint16_t *out_port)
Validate port number (1-65535)
Definition options/common.c:112
parse_height_option
asciichat_error_t parse_height_option(const char *value_str, options_t *opts)
Parse –height option and set opts->height.
Definition options/common.c:465
validate_fps_opt
bool validate_fps_opt(const char *value_str, int *out_fps)
Validate FPS value (1-144)
Definition options/common.c:127
parse_palette_chars_option
asciichat_error_t parse_palette_chars_option(const char *value_str, options_t *opts)
Parse –palette-chars option and set opt_palette_custom.
Definition options/common.c:430
parse_palette_option
asciichat_error_t parse_palette_option(const char *value_str, options_t *opts)
Parse –palette option and set opt_palette_type.
Definition options/common.c:404
parse_log_level_option
asciichat_error_t parse_log_level_option(const char *value_str, options_t *opts)
Parse –log-level option and set opt_log_level.
Definition options/common.c:513
validate_positive_int_opt
bool validate_positive_int_opt(const char *value_str, int *out_value, const char *param_name)
Validate a positive integer value.
Definition options/common.c:96
parse_color_mode_option
asciichat_error_t parse_color_mode_option(const char *value_str, options_t *opts)
Parse –color-mode option and set opts->color_mode.
Definition options/common.c:361
parse_snapshot_delay_option
asciichat_error_t parse_snapshot_delay_option(const char *value_str, options_t *opts)
Parse –snapshot-delay option and set opts->snapshot_delay.
Definition options/common.c:496
get_required_argument
char * get_required_argument(const char *opt_value, char *buffer, size_t buffer_size, const char *option_name, asciichat_mode_t mode)
Handle required arguments with consistent error messages.
Definition options/common.c:215
parse_webcam_index_option
asciichat_error_t parse_webcam_index_option(const char *value_str, options_t *opts)
Parse –webcam-index option and set opts->webcam_index.
Definition options/common.c:481
validate_webcam_index
bool validate_webcam_index(const char *value_str, unsigned short int *out_index)
Validate webcam index using the common device index validator.
Definition options/common.c:143
update_dimensions_for_full_height
void update_dimensions_for_full_height(options_t *opts)
Update dimensions for full-height mode.
Definition options/common.c:535
options.h
⚙️ Command-line options parsing and configuration management for ascii-chat
options_state
Consolidated options structure.
Definition options.h:439