options.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stdio.h>
#include "platform/terminal.h"
#include "video/palette.h"
 
#define COLOR_MODE_AUTO TERM_COLOR_AUTO           
#define COLOR_MODE_NONE TERM_COLOR_NONE           
#define COLOR_MODE_16 TERM_COLOR_16               
#define COLOR_MODE_16_COLOR TERM_COLOR_16         
#define COLOR_MODE_256 TERM_COLOR_256             
#define COLOR_MODE_256_COLOR TERM_COLOR_256       
#define COLOR_MODE_TRUECOLOR TERM_COLOR_TRUECOLOR 
 
#define OPTIONS_BUFF_SIZE 256
 
#define OPT_WIDTH_DEFAULT 110
 
#define OPT_HEIGHT_DEFAULT 70
 
#if defined(__APPLE__)
// macOS webcams show pure black first then fade up into a real color image over a few seconds
#define SNAPSHOT_DELAY_DEFAULT 4.0f
#else
#define SNAPSHOT_DELAY_DEFAULT 3.0f
#endif
 
#define OPT_PORT_DEFAULT "27224"
 
#define OPT_ADDRESS_DEFAULT "localhost"
 
#define OPT_ADDRESS6_DEFAULT "::1"
 
#define OPT_MAX_CLIENTS_DEFAULT 9
 
#define OPT_COMPRESSION_LEVEL_DEFAULT 1
 
#define OPT_FPS_DEFAULT 60
 
#define OPT_WEBCAM_INDEX_DEFAULT 0
 
#define OPT_MICROPHONE_INDEX_DEFAULT (-1)
 
#define OPT_SPEAKERS_INDEX_DEFAULT (-1)
 
#define OPT_RECONNECT_ATTEMPTS_DEFAULT (-1)
 
#define OPT_WEBCAM_FLIP_DEFAULT true
 
#define OPT_COLOR_MODE_DEFAULT COLOR_MODE_AUTO
 
#define OPT_RENDER_MODE_DEFAULT RENDER_MODE_FOREGROUND
 
#define OPT_ENCODE_AUDIO_DEFAULT true
 
int strtoint_safe(const char *str);
 
// ============================================================================
// Struct Definition Macros for Library Users
// ============================================================================
 
#define ASCIICHAT_BINARY_OPTIONS_STRUCT                                                                                \
  bool help;                                                                                                           \
  bool version;                                                                                                        \
  char log_file[OPTIONS_BUFF_SIZE];                                                                                    \
  log_level_t log_level;                                                                                               \
  unsigned short int quiet;                                                                                            \
  unsigned short int verbose_level;
 
#define ASCIICHAT_COMMON_OPTIONS_STRUCT                                                                                \
  ASCIICHAT_BINARY_OPTIONS_STRUCT                                                                                      \
  unsigned short int width;                                                                                            \
  unsigned short int height;                                                                                           \
  bool auto_width;                                                                                                     \
  bool auto_height;
 
#define ASCIICHAT_SERVER_OPTIONS_STRUCT                                                                                \
  ASCIICHAT_COMMON_OPTIONS_STRUCT                                                                                      \
  char address[OPTIONS_BUFF_SIZE];                                                                                     \
  char address6[OPTIONS_BUFF_SIZE];                                                                                    \
  char port[OPTIONS_BUFF_SIZE];                                                                                        \
  int max_clients;                                                                                                     \
  int compression_level;                                                                                               \
  bool no_compress;                                                                                                    \
  bool encode_audio;                                                                                                   \
  unsigned short int encrypt_enabled;                                                                                  \
  char encrypt_key[OPTIONS_BUFF_SIZE];                                                                                 \
  char password[OPTIONS_BUFF_SIZE];                                                                                    \
  char encrypt_keyfile[OPTIONS_BUFF_SIZE];                                                                             \
  unsigned short int no_encrypt;                                                                                       \
  char client_keys[OPTIONS_BUFF_SIZE];                                                                                 \
  unsigned short int require_server_verify;                                                                            \
  bool acds;           /* Enable ACDS session registration (default: false) */                                         \
  bool acds_expose_ip; /* Explicitly allow public IP disclosure in ACDS sessions (opt-in) */                           \
  bool acds_insecure;  /* Skip server key verification (MITM-vulnerable, requires explicit opt-in) */                  \
  char acds_server[OPTIONS_BUFF_SIZE];                                                                                 \
  int acds_port;                                                                                                       \
  bool webrtc; /* Enable WebRTC mode for ACDS session (default: Direct TCP) */
 
#define ASCIICHAT_CLIENT_OPTIONS_STRUCT                                                                                \
  ASCIICHAT_COMMON_OPTIONS_STRUCT                                                                                      \
  char address[OPTIONS_BUFF_SIZE];                                                                                     \
  char port[OPTIONS_BUFF_SIZE];                                                                                        \
  int reconnect_attempts;                                                                                              \
  unsigned short int webcam_index;                                                                                     \
  bool webcam_flip;                                                                                                    \
  bool test_pattern;                                                                                                   \
  terminal_color_mode_t color_mode;                                                                                    \
  render_mode_t render_mode;                                                                                           \
  unsigned short int show_capabilities;                                                                                \
  unsigned short int force_utf8;                                                                                       \
  unsigned short int audio_enabled;                                                                                    \
  int microphone_index;                                                                                                \
  int speakers_index;                                                                                                  \
  unsigned short int stretch;                                                                                          \
  unsigned short int snapshot_mode;                                                                                    \
  double snapshot_delay;                                                                                               \
  char server_key[OPTIONS_BUFF_SIZE];                                                                                  \
  char encrypt_key[OPTIONS_BUFF_SIZE];                                                                                 \
  char password[OPTIONS_BUFF_SIZE];                                                                                    \
  unsigned short int require_client_verify;
 
#define ASCIICHAT_MIRROR_OPTIONS_STRUCT                                                                                \
  ASCIICHAT_COMMON_OPTIONS_STRUCT                                                                                      \
  unsigned short int webcam_index;                                                                                     \
  bool webcam_flip;                                                                                                    \
  bool test_pattern;                                                                                                   \
  terminal_color_mode_t color_mode;                                                                                    \
  render_mode_t render_mode;                                                                                           \
  unsigned short int force_utf8;                                                                                       \
  unsigned short int stretch;
 
#define ASCIICHAT_ACDS_OPTIONS_STRUCT                                                                                  \
  ASCIICHAT_COMMON_OPTIONS_STRUCT                                                                                      \
  char address[OPTIONS_BUFF_SIZE];                                                                                     \
  char port[OPTIONS_BUFF_SIZE];                                                                                        \
  unsigned short int require_server_identity;                                                                          \
  unsigned short int require_client_identity;                                                                          \
  unsigned short int require_server_verify;                                                                            \
  unsigned short int require_client_verify;                                                                            \
  char stun_servers[OPTIONS_BUFF_SIZE];                                                                                \
  char turn_servers[OPTIONS_BUFF_SIZE];                                                                                \
  char turn_username[OPTIONS_BUFF_SIZE];                                                                               \
  char turn_credential[OPTIONS_BUFF_SIZE];                                                                             \
  char turn_secret[OPTIONS_BUFF_SIZE];
 
typedef enum {
  MODE_SERVER, 
  MODE_CLIENT, 
  MODE_MIRROR, 
  MODE_ACDS    
} asciichat_mode_t;
 
typedef struct options_state {
  // ============================================================================
  // Mode Detection (auto-detected during options_init)
  // ============================================================================
  asciichat_mode_t detected_mode; 
 
  // ============================================================================
  // Binary-Level Options (parsed first, before mode selection)
  // ============================================================================
  bool help;    
  bool version; 
 
  // ============================================================================
  // Terminal Dimensions
  // ============================================================================
  unsigned short int width;  
  unsigned short int height; 
  bool auto_width;           
  bool auto_height;          
 
  // ============================================================================
  // Network Options
  // ============================================================================
  char address[OPTIONS_BUFF_SIZE];  
  char address6[OPTIONS_BUFF_SIZE]; 
  char port[OPTIONS_BUFF_SIZE];     
  int max_clients;                  
  char session_string[64];          
 
  // ============================================================================
  // ACDS Discovery Options (server only)
  // ============================================================================
  bool acds;                                  
  char acds_server[OPTIONS_BUFF_SIZE];        
  int acds_port;                              
  bool webrtc;                                
  char acds_key_path[OPTIONS_BUFF_SIZE];      
  char acds_database_path[OPTIONS_BUFF_SIZE]; 
 
  // ============================================================================
  // LAN Discovery Options
  // ============================================================================
  bool lan_discovery;     
  bool no_mdns_advertise; 
 
  // ============================================================================
  // Network Performance Options
  // ============================================================================
  int compression_level; 
  bool no_compress;      
  bool encode_audio;     
 
  // ============================================================================
  // Client Reconnection Options
  // ============================================================================
  int reconnect_attempts; 
 
  // ============================================================================
  // Webcam Options
  // ============================================================================
  unsigned short int webcam_index; 
  bool webcam_flip;                
  bool test_pattern;               
  bool no_audio_mixer;             
 
  // ============================================================================
  // Display Options
  // ============================================================================
  terminal_color_mode_t color_mode;     
  render_mode_t render_mode;            
  unsigned short int show_capabilities; 
  unsigned short int force_utf8;        
  int fps;                              
 
  // ============================================================================
  // Audio Configuration
  // ============================================================================
  unsigned short int audio_enabled;          
  int microphone_index;                      
  int speakers_index;                        
  unsigned short int audio_analysis_enabled; 
  unsigned short int audio_no_playback;      
 
  // ============================================================================
  // Image Options
  // ============================================================================
  unsigned short int stretch; 
 
  // ============================================================================
  // Output Options
  // ============================================================================
  unsigned short int quiet;         
  unsigned short int verbose_level; 
  unsigned short int snapshot_mode; 
  double snapshot_delay;            
  unsigned short int strip_ansi;    
  char log_file[OPTIONS_BUFF_SIZE]; 
  log_level_t log_level;            
 
  // ============================================================================
  // Encryption Options
  // ============================================================================
  unsigned short int encrypt_enabled;      
  char encrypt_key[OPTIONS_BUFF_SIZE];     
  char password[OPTIONS_BUFF_SIZE];        
  char encrypt_keyfile[OPTIONS_BUFF_SIZE]; 
  unsigned short int no_encrypt;           
  char server_key[OPTIONS_BUFF_SIZE];      
  char client_keys[OPTIONS_BUFF_SIZE];     
 
  // ============================================================================
  // Identity Verification Options (ACDS + Crypto Handshake)
  // ============================================================================
  bool require_server_identity; 
  bool require_client_identity; 
  bool require_server_verify;   
  bool require_client_verify;   
  bool acds_expose_ip;          
  bool acds_insecure;           
 
  // ============================================================================
  // WebRTC Connection Strategy Options (client-side fallback control)
  // ============================================================================
  bool prefer_webrtc;       
  bool no_webrtc;           
  bool webrtc_skip_stun;    
  bool webrtc_disable_turn; 
 
  // ============================================================================
  // WebRTC Connectivity Options (ACDS mode only)
  // ============================================================================
  bool enable_upnp;                        
  bool no_upnp;                            
  char stun_servers[OPTIONS_BUFF_SIZE];    
  char turn_servers[OPTIONS_BUFF_SIZE];    
  char turn_username[OPTIONS_BUFF_SIZE];   
  char turn_credential[OPTIONS_BUFF_SIZE]; 
  char turn_secret[OPTIONS_BUFF_SIZE];     
 
  // ============================================================================
  // Palette Configuration
  // ============================================================================
  palette_type_t palette_type; 
  char palette_custom[256];    
  bool palette_custom_set;     
 
  // Note: Luminance weights (weight_red, weight_green, weight_blue) and
  // lookup tables (RED[], GREEN[], BLUE[], GRAY[]) are kept as globals
  // since they're precomputed constants, not user-configurable options.
} options_t;
 
// ============================================================================
// RCU-based thread-safe options access
// ============================================================================
 
const options_t *options_get(void);
 
#define GET_OPTION(field)                                                                                              \
  ({                                                                                                                   \
    const options_t *_opts = options_get();                                                                            \
    if (!_opts) {                                                                                                      \
      log_warn("GET_OPTION(" #field ") called but options not initialized");                                           \
    }                                                                                                                  \
    static typeof(((options_t *)0)->field) _default = {0};                                                             \
    (_opts ? (_opts->field) : _default);                                                                               \
  })
 
asciichat_error_t options_update(void (*updater)(options_t *, void *), void *context);
 
asciichat_error_t options_set_dimensions(unsigned short int width, unsigned short int height);
 
asciichat_error_t options_set_color_mode(terminal_color_mode_t mode);
 
asciichat_error_t options_set_render_mode(render_mode_t mode);
 
asciichat_error_t options_set_log_level(log_level_t level);
 
static inline unsigned short int options_get_width(void) {
  return options_get()->width;
}
 
static inline unsigned short int options_get_height(void) {
  return options_get()->height;
}
 
extern const float weight_red;
 
extern const float weight_green;
 
extern const float weight_blue;
 
extern unsigned short int RED[];
 
extern unsigned short int GREEN[];
 
extern unsigned short int BLUE[];
 
extern unsigned short int GRAY[];
 
asciichat_error_t options_init(int argc, char **argv);
 
void usage(FILE *desc, asciichat_mode_t mode);
 
void usage_client(FILE *desc);
 
void usage_server(FILE *desc);
 
void usage_mirror(FILE *desc);
 
void usage_acds(FILE *desc);
 
void update_dimensions_for_full_height(options_t *opts);
 
void update_dimensions_to_terminal_size(options_t *opts);