ascii-chat
Binary v0.16.50-198-g78f51665f
Library lib/v0.3.2-2240-g78f51665f
Video chat in your terminal
Loading...
Searching...
No Matches
compression.c
Go to the documentation of this file.
1
6
7#include <zstd.h>
8#include <ascii-chat/otel.h>
9#include <ascii-chat/buffer.h>
10#include <string.h>
12#include <ascii-chat/common.h>
13#include <recast/defer.h>
14#include <ascii-chat/asciichat_errno.h> // For asciichat_errno system
15
16static void compression_measure(size_t input, size_t output, bool compressing) {
17 ascii_otel_metric(compressing ? ASCII_OTEL_METRIC_COMPRESS_INPUT : ASCII_OTEL_METRIC_DECOMPRESS_INPUT, (double)input);
18 ascii_otel_metric(compressing ? ASCII_OTEL_METRIC_COMPRESS_OUTPUT : ASCII_OTEL_METRIC_DECOMPRESS_OUTPUT, (double)output);
19 if (compressing) {
20 ascii_otel_metric(ASCII_OTEL_METRIC_COMPRESS_BYTES_IN, (double)input);
21 ascii_otel_metric(ASCII_OTEL_METRIC_COMPRESS_BYTES_OUT, (double)output);
22 if (input)
23 ascii_otel_metric(ASCII_OTEL_METRIC_COMPRESS_RATIO, (double)output / (double)input);
24 } else
25 ascii_otel_metric(ASCII_OTEL_METRIC_DECOMPRESS_BYTES_OUT, (double)output);
26}
27
28// Compress data using zstd with configurable compression level
29asciichat_error_t compress_data(const void *input, size_t input_size, void **output, size_t *output_size, int compression_level) {
30 ASCII_OTEL_SCOPE(ZSTD_COMPRESS);
31 ASCII_OTEL_ATTR_STRING("compression.algorithm", "zstd");
32 ASCII_OTEL_ATTR_STRING("compression.library.version", ZSTD_versionString());
33 ASCII_OTEL_ATTR_INT("compression.level", compression_level);
34 ASCII_OTEL_ATTR_INT("compression.input.size", (int64_t)input_size);
35 if (!input || input_size == 0 || !output || !output_size) {
36 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters: input=%p, input_size=%zu, output=%p, output_size=%p", input, input_size, output, output_size);
37 }
38
39 // Validate compression level (1-9 for real-time streaming)
40 if (compression_level < 1 || compression_level > 9) {
41 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid compression level %d: must be between 1 and 9", compression_level);
42 }
43
44 // Calculate maximum compressed size
45 size_t compressed_size = ZSTD_compressBound(input_size);
46
47 // Sanity check ZSTD_compressBound result
48 // ZSTD_compressBound returns 0 for errors or very large values for huge inputs
49 if (compressed_size == 0 || compressed_size > 256 * 1024 * 1024) { // Max 256MB compressed buffer
50 return SET_ERRNO(ERROR_INVALID_PARAM, "ZSTD_compressBound returned unreasonable size: %zu for input %zu", compressed_size, input_size);
51 }
52
53 unsigned char *compressed_data = NULL;
54 compressed_data = buffer_alloc(NULL, compressed_size);
55
56 if (!compressed_data) {
57 return SET_ERRNO(ERROR_MEMORY, "Failed to allocate compressed data buffer");
58 }
59 defer_named(release_compressed, buffer_release(compressed_data));
60
61 // Compress using zstd with user-specified compression level
62 size_t ret = ZSTD_compress(compressed_data, compressed_size, input, input_size, compression_level);
63
64 if (ZSTD_isError(ret)) {
65 return SET_ERRNO(ERROR_GENERAL, "zstd compression failed: %s", ZSTD_getErrorName(ret));
66 }
67
68 *output = compressed_data;
69 defer_cancel(release_compressed);
70 *output_size = ret;
71 ASCII_OTEL_ATTR_INT("compression.output.size", (int64_t)ret);
72 ASCII_OTEL_ATTR_INT("compression.ratio.permille", (int64_t)(1000.0 * (double)ret / (double)input_size));
73 compression_measure(input_size, ret, true);
74
75 return ASCIICHAT_OK;
76}
77
78// Decompress data using zstd
79asciichat_error_t decompress_data(const void *input, size_t input_size, void *output, size_t output_size) {
80 ASCII_OTEL_SCOPE(ZSTD_DECOMPRESS);
81 ASCII_OTEL_ATTR_STRING("compression.algorithm", "zstd");
82 ASCII_OTEL_ATTR_STRING("compression.library.version", ZSTD_versionString());
83 ASCII_OTEL_ATTR_INT("compression.input.size", (int64_t)input_size);
84 ASCII_OTEL_ATTR_INT("compression.output.capacity", (int64_t)output_size);
85 if (!input || input_size == 0 || !output || output_size == 0) {
86 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters: input=%p, input_size=%zu, output=%p, output_size=%zu", input, input_size, output, output_size);
87 }
88
89 size_t ret = ZSTD_decompress(output, output_size, input, input_size);
90
91 if (ZSTD_isError(ret)) {
92 return SET_ERRNO(ERROR_GENERAL, "zstd decompression failed: %s", ZSTD_getErrorName(ret));
93 }
94
95 ASCII_OTEL_ATTR_INT("compression.output.size", (int64_t)ret);
96 ASCII_OTEL_ATTR_INT("compression.ratio.permille", (int64_t)(1000.0 * (double)ret / (double)input_size));
97 compression_measure(input_size, ret, false);
98 return ASCIICHAT_OK;
99}
100
101// Rendered frames must fill every advertised byte; a short decode must not
102// expose stale workspace bytes or uninitialized allocation tails to CRC/parser.
103asciichat_error_t decompress_data_exact(const void *input, size_t input_size, void *output, size_t expected_size) {
104 ASCII_OTEL_SCOPE(ZSTD_DECOMPRESS_EXACT);
105 ASCII_OTEL_ATTR_STRING("compression.algorithm", "zstd");
106 ASCII_OTEL_ATTR_STRING("compression.library.version", ZSTD_versionString());
107 ASCII_OTEL_ATTR_INT("compression.input.size", (int64_t)input_size);
108 ASCII_OTEL_ATTR_INT("compression.expected_output.size", (int64_t)expected_size);
109 if (!input || !input_size || !output || !expected_size)
110 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid exact decompression bounds");
111 size_t decoded = ZSTD_decompress(output, expected_size, input, input_size);
112 if (ZSTD_isError(decoded) || decoded != expected_size)
113 return SET_ERRNO(ERROR_COMPRESSION, "Decompressed payload does not match expected size %zu", expected_size);
114 ASCII_OTEL_ATTR_INT("compression.output.size", (int64_t)decoded);
115 compression_measure(input_size, decoded, false);
116 return ASCIICHAT_OK;
117}
118
119// Check if compression is worthwhile based on ratio
120bool should_compress(size_t original_size, size_t compressed_size) {
121 if (original_size == 0)
122 return false;
123
124 float ratio = (float)compressed_size / (float)original_size;
125 return ratio < COMPRESSION_RATIO_THRESHOLD;
126}
127
128asciichat_error_t compress_workspace(compression_workspace_t *workspace, const void *input, size_t size, int level) {
129 ASCII_OTEL_SCOPE(ZSTD_COMPRESS_WORKSPACE);
130 ASCII_OTEL_ATTR_STRING("compression.algorithm", "zstd");
131 ASCII_OTEL_ATTR_STRING("compression.library.version", ZSTD_versionString());
132 ASCII_OTEL_ATTR_INT("compression.level", level);
133 ASCII_OTEL_ATTR_INT("compression.input.size", (int64_t)size);
134 if (!workspace || !input || !size || level < 1 || level > 9)
135 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid compression workspace request");
136 workspace->output.length = 0;
137 size_t bound = ZSTD_compressBound(size);
138 if (!bound || bound > 256 * 1024 * 1024)
139 return SET_ERRNO(ERROR_INVALID_PARAM, "Compression workspace exceeds maximum size");
140 asciichat_error_t result = buffer_workspace_reserve(&workspace->output, NULL, bound);
141 if (result != ASCIICHAT_OK)
142 return result;
143 if (!workspace->codec)
144 workspace->codec = ZSTD_createCCtx();
145 if (!workspace->codec)
146 return SET_ERRNO(ERROR_MEMORY, "Cannot create compression context");
147 size_t written = ZSTD_compressCCtx(workspace->codec, workspace->output.data, buffer_capacity(workspace->output.data), input, size, level);
148 if (ZSTD_isError(written))
149 return SET_ERRNO(ERROR_GENERAL, "Compression failed: %s", ZSTD_getErrorName(written));
150 workspace->output.length = written;
151 result = buffer_set_size(workspace->output.data, written);
152 if (result == ASCIICHAT_OK) {
153 ASCII_OTEL_ATTR_INT("compression.output.size", (int64_t)written);
154 ASCII_OTEL_ATTR_INT("compression.ratio.permille", (int64_t)(1000.0 * (double)written / (double)size));
155 compression_measure(size, written, true);
156 }
157 return result;
158}
159
161 if (!workspace)
162 return;
163 ZSTD_freeCCtx(workspace->codec);
164 workspace->codec = NULL;
165 buffer_workspace_destroy(&workspace->output);
166}
Synchronized per-thread pending error stacks and value snapshots. SET_ERRNO pushes,...
#define SET_ERRNO(code,...)
size_t buffer_capacity(const void *data)
Definition buffer.c:278
asciichat_error_t buffer_workspace_reserve(buffer_workspace_t *workspace, buffer_domain_t *domain, size_t capacity)
Definition buffer.c:353
asciichat_error_t buffer_set_size(void *data, size_t size)
Definition buffer.c:285
void * buffer_alloc(buffer_domain_t *domain, size_t size)
Definition buffer.c:272
void buffer_workspace_destroy(buffer_workspace_t *workspace)
Definition buffer.c:371
#define buffer_release(data)
Definition buffer.h:99
void compression_workspace_destroy(compression_workspace_t *workspace)
asciichat_error_t compress_workspace(compression_workspace_t *workspace, const void *input, size_t size, int level)
📦 Network Packet Compression Utilities
asciichat_error_t decompress_data_exact(const void *input, size_t input_size, void *output, size_t expected_size)
asciichat_error_t decompress_data(const void *input, size_t input_size, void *output, size_t output_size)
Decompress data using zstd.
Definition compression.c:79
bool should_compress(size_t original_size, size_t compressed_size)
Determine if compression should be used for given data sizes.
asciichat_error_t compress_data(const void *input, size_t input_size, void **output, size_t *output_size, int compression_level)
Compress data using zstd with configurable compression level.
Definition compression.c:29
#define COMPRESSION_RATIO_THRESHOLD
Compression ratio threshold - only use if <80% original size.
Definition compression.h:63
asciichat_error_t
Error and exit codes - unified status values (0-255).
Definition error_codes.h:48
@ ERROR_COMPRESSION
@ ERROR_MEMORY
Definition error_codes.h:55
@ ASCIICHAT_OK
Definition error_codes.h:50
@ ERROR_GENERAL
Definition error_codes.h:51
@ ERROR_INVALID_PARAM
⚙️ Common definitions, error codes, macros, and types shared throughout the application
void ascii_otel_metric(ascii_otel_metric_t metric, double value)
Definition otel.c:159
#define ASCII_OTEL_SCOPE(id)
Definition otel.h:77
#define ASCII_OTEL_ATTR_INT(key, value)
Definition otel.h:72
#define ASCII_OTEL_ATTR_STRING(key, value)
Definition otel.h:71
🔤 String Manipulation and Shell Escaping Utilities
Owns the temporary storage used by compression workspace. The data pointers and size or cursor fields...
buffer_workspace_t output