]> sigrok.org Git - libsigrok.git/blame - src/output/srzip.c
output/srzip: accept arbitrary input and output unit sizes
[libsigrok.git] / src / output / srzip.c
CommitLineData
3250d8c7
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
6ec6c43b 20#include <config.h>
3250d8c7 21#include <stdlib.h>
3250d8c7
BV
22#include <string.h>
23#include <errno.h>
24#include <glib.h>
25#include <glib/gstdio.h>
26#include <zip.h>
c1aae900 27#include <libsigrok/libsigrok.h>
3250d8c7
BV
28#include "libsigrok-internal.h"
29
30#define LOG_PREFIX "output/srzip"
c03aaf34 31#define CHUNK_SIZE (4 * 1024 * 1024)
3250d8c7
BV
32
33struct out_context {
34 gboolean zip_created;
35 uint64_t samplerate;
36 char *filename;
c03aaf34
GS
37 size_t first_analog_index;
38 size_t analog_ch_count;
0586a0ef 39 gint *analog_index_map;
c03aaf34 40 struct logic_buff {
e4cfebe0 41 size_t zip_unit_size;
c03aaf34
GS
42 size_t alloc_size;
43 uint8_t *samples;
44 size_t fill_size;
45 } logic_buff;
46 struct analog_buff {
47 size_t alloc_size;
48 float *samples;
49 size_t fill_size;
50 } *analog_buff;
3250d8c7
BV
51};
52
53static int init(struct sr_output *o, GHashTable *options)
54{
55 struct out_context *outc;
56
37875f75
SA
57 (void)options;
58
98654c99 59 if (!o->filename || o->filename[0] == '\0') {
37875f75 60 sr_info("srzip output module requires a file name, cannot save.");
3250d8c7 61 return SR_ERR_ARG;
37875f75 62 }
7df31ae8 63
9dde7460 64 outc = g_malloc0(sizeof(*outc));
37875f75 65 outc->filename = g_strdup(o->filename);
7df31ae8 66 o->priv = outc;
3250d8c7
BV
67
68 return SR_OK;
69}
70
71static int zip_create(const struct sr_output *o)
72{
73 struct out_context *outc;
3250d8c7
BV
74 struct zip *zipfile;
75 struct zip_source *versrc, *metasrc;
98654c99 76 struct sr_channel *ch;
c03aaf34
GS
77 size_t ch_nr;
78 size_t alloc_size;
3250d8c7 79 GVariant *gvar;
98654c99 80 GKeyFile *meta;
3250d8c7 81 GSList *l;
98654c99
DE
82 const char *devgroup;
83 char *s, *metabuf;
84 gsize metalen;
c03aaf34
GS
85 guint logic_channels, enabled_logic_channels;
86 guint enabled_analog_channels;
0586a0ef 87 guint index;
3250d8c7
BV
88
89 outc = o->priv;
98654c99
DE
90
91 if (outc->samplerate == 0 && sr_config_get(o->sdi->driver, o->sdi, NULL,
92 SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
93 outc->samplerate = g_variant_get_uint64(gvar);
94 g_variant_unref(gvar);
3250d8c7
BV
95 }
96
97 /* Quietly delete it first, libzip wants replace ops otherwise. */
98654c99
DE
98 g_unlink(outc->filename);
99 zipfile = zip_open(outc->filename, ZIP_CREATE, NULL);
100 if (!zipfile)
3250d8c7
BV
101 return SR_ERR;
102
103 /* "version" */
98654c99 104 versrc = zip_source_buffer(zipfile, "2", 1, FALSE);
eaa6a7a3 105 if (zip_add(zipfile, "version", versrc) < 0) {
98654c99 106 sr_err("Error saving version into zipfile: %s",
3250d8c7 107 zip_strerror(zipfile));
98654c99
DE
108 zip_source_free(versrc);
109 zip_discard(zipfile);
3250d8c7
BV
110 return SR_ERR;
111 }
112
113 /* init "metadata" */
98654c99
DE
114 meta = g_key_file_new();
115
116 g_key_file_set_string(meta, "global", "sigrok version",
2868bca3 117 sr_package_version_string_get());
98654c99
DE
118
119 devgroup = "device 1";
26918dce 120
c03aaf34
GS
121 logic_channels = 0;
122 enabled_logic_channels = 0;
123 enabled_analog_channels = 0;
82883219
ML
124 for (l = o->sdi->channels; l; l = l->next) {
125 ch = l->data;
0586a0ef 126
eab05299 127 switch (ch->type) {
74a9c0ad 128 case SR_CHANNEL_LOGIC:
0586a0ef
SA
129 if (ch->enabled)
130 enabled_logic_channels++;
74a9c0ad
UH
131 logic_channels++;
132 break;
133 case SR_CHANNEL_ANALOG:
0586a0ef
SA
134 if (ch->enabled)
135 enabled_analog_channels++;
74a9c0ad 136 break;
eab05299 137 }
82883219
ML
138 }
139
0586a0ef
SA
140 /* When reading the file, the first index of the analog channels
141 * can only be deduced through the "total probes" count, so the
142 * first analog index must follow the last logic one, enabled or not. */
143 if (enabled_logic_channels > 0)
144 outc->first_analog_index = logic_channels + 1;
145 else
146 outc->first_analog_index = 1;
147
148 /* Only set capturefile and probes if we will actually save logic data. */
149 if (enabled_logic_channels > 0) {
150 g_key_file_set_string(meta, devgroup, "capturefile", "logic-1");
151 g_key_file_set_integer(meta, devgroup, "total probes", logic_channels);
152 }
153
154 s = sr_samplerate_string(outc->samplerate);
155 g_key_file_set_string(meta, devgroup, "samplerate", s);
156 g_free(s);
157
158 g_key_file_set_integer(meta, devgroup, "total analog", enabled_analog_channels);
e5b280e4 159
c03aaf34 160 outc->analog_ch_count = enabled_analog_channels;
9dde7460 161 alloc_size = sizeof(gint) * outc->analog_ch_count + 1;
c03aaf34 162 outc->analog_index_map = g_malloc0(alloc_size);
82883219 163
0586a0ef 164 index = 0;
3250d8c7
BV
165 for (l = o->sdi->channels; l; l = l->next) {
166 ch = l->data;
0586a0ef
SA
167 if (!ch->enabled)
168 continue;
169
f3963517 170 s = NULL;
eab05299 171 switch (ch->type) {
74a9c0ad 172 case SR_CHANNEL_LOGIC:
c03aaf34
GS
173 ch_nr = ch->index + 1;
174 s = g_strdup_printf("probe%zu", ch_nr);
74a9c0ad
UH
175 break;
176 case SR_CHANNEL_ANALOG:
c03aaf34 177 ch_nr = outc->first_analog_index + index;
0586a0ef 178 outc->analog_index_map[index] = ch->index;
c03aaf34 179 s = g_strdup_printf("analog%zu", ch_nr);
0586a0ef 180 index++;
74a9c0ad 181 break;
98654c99 182 }
f3963517
GS
183 if (s) {
184 g_key_file_set_string(meta, devgroup, s, ch->name);
185 g_free(s);
186 }
3250d8c7 187 }
82883219 188
c03aaf34
GS
189 /*
190 * Allocate one samples buffer for all logic channels, and
191 * several samples buffers for the analog channels. Allocate
192 * buffers of CHUNK_SIZE size (in bytes), and determine the
193 * sample counts from the respective channel counts and data
194 * type widths.
195 *
196 * These buffers are intended to reduce the number of ZIP
197 * archive update calls, and decouple the srzip output module
198 * from implementation details in other acquisition device
199 * drivers and input modules.
9dde7460
GS
200 *
201 * Avoid allocating zero bytes, to not depend on platform
202 * specific malloc(0) return behaviour. Avoid division by zero,
203 * holding a local buffer won't harm when no data is seen later
204 * during execution. This simplifies other locations.
c03aaf34
GS
205 */
206 alloc_size = CHUNK_SIZE;
e4cfebe0
GS
207 outc->logic_buff.zip_unit_size = logic_channels;
208 outc->logic_buff.zip_unit_size += 8 - 1;
209 outc->logic_buff.zip_unit_size /= 8;
c03aaf34
GS
210 outc->logic_buff.samples = g_try_malloc0(alloc_size);
211 if (!outc->logic_buff.samples)
212 return SR_ERR_MALLOC;
e4cfebe0
GS
213 if (outc->logic_buff.zip_unit_size)
214 alloc_size /= outc->logic_buff.zip_unit_size;
c03aaf34
GS
215 outc->logic_buff.alloc_size = alloc_size;
216 outc->logic_buff.fill_size = 0;
217
9dde7460 218 alloc_size = sizeof(outc->analog_buff[0]) * outc->analog_ch_count + 1;
c03aaf34
GS
219 outc->analog_buff = g_malloc0(alloc_size);
220 for (index = 0; index < outc->analog_ch_count; index++) {
221 alloc_size = CHUNK_SIZE;
222 outc->analog_buff[index].samples = g_try_malloc0(alloc_size);
223 if (!outc->analog_buff[index].samples)
224 return SR_ERR_MALLOC;
225 alloc_size /= sizeof(outc->analog_buff[0].samples[0]);
226 outc->analog_buff[index].alloc_size = alloc_size;
227 outc->analog_buff[index].fill_size = 0;
228 }
229
98654c99
DE
230 metabuf = g_key_file_to_data(meta, &metalen, NULL);
231 g_key_file_free(meta);
3250d8c7 232
98654c99 233 metasrc = zip_source_buffer(zipfile, metabuf, metalen, FALSE);
eaa6a7a3 234 if (zip_add(zipfile, "metadata", metasrc) < 0) {
98654c99
DE
235 sr_err("Error saving metadata into zipfile: %s",
236 zip_strerror(zipfile));
237 zip_source_free(metasrc);
238 zip_discard(zipfile);
239 g_free(metabuf);
3250d8c7
BV
240 return SR_ERR;
241 }
242
98654c99
DE
243 if (zip_close(zipfile) < 0) {
244 sr_err("Error saving zipfile: %s", zip_strerror(zipfile));
245 zip_discard(zipfile);
246 g_free(metabuf);
3250d8c7
BV
247 return SR_ERR;
248 }
98654c99 249 g_free(metabuf);
3250d8c7
BV
250
251 return SR_OK;
252}
253
c03aaf34
GS
254/**
255 * Append a block of logic data to an srzip archive.
256 *
257 * @param[in] o Output module instance.
258 * @param[in] buf Logic data samples as byte sequence.
259 * @param[in] unitsize Logic data unit size (bytes per sample).
260 * @param[in] length Byte sequence length (in bytes, not samples).
261 *
262 * @returns SR_OK et al error codes.
263 */
264static int zip_append(const struct sr_output *o,
265 uint8_t *buf, size_t unitsize, size_t length)
3250d8c7
BV
266{
267 struct out_context *outc;
268 struct zip *archive;
269 struct zip_source *logicsrc;
98654c99 270 int64_t i, num_files;
3250d8c7
BV
271 struct zip_stat zs;
272 struct zip_source *metasrc;
273 GKeyFile *kf;
274 GError *error;
98654c99 275 uint64_t chunk_num;
3250d8c7 276 const char *entry_name;
98654c99
DE
277 char *metabuf;
278 gsize metalen;
279 char *chunkname;
280 unsigned int next_chunk_num;
3250d8c7 281
c03aaf34
GS
282 if (!length)
283 return SR_OK;
284
3250d8c7 285 outc = o->priv;
98654c99 286 if (!(archive = zip_open(outc->filename, 0, NULL)))
3250d8c7
BV
287 return SR_ERR;
288
98654c99
DE
289 if (zip_stat(archive, "metadata", 0, &zs) < 0) {
290 sr_err("Failed to open metadata: %s", zip_strerror(archive));
291 zip_discard(archive);
3250d8c7 292 return SR_ERR;
98654c99
DE
293 }
294 kf = sr_sessionfile_read_metadata(archive, &zs);
295 if (!kf) {
296 zip_discard(archive);
297 return SR_ERR_DATA;
298 }
3250d8c7
BV
299 /*
300 * If the file was only initialized but doesn't yet have any
301 * data it in, it won't have a unitsize field in metadata yet.
302 */
303 error = NULL;
98654c99 304 metabuf = NULL;
3250d8c7
BV
305 if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
306 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
98654c99
DE
307 sr_err("Failed to check unitsize key: %s", error->message);
308 g_error_free(error);
309 g_key_file_free(kf);
310 zip_discard(archive);
3250d8c7
BV
311 return SR_ERR;
312 }
98654c99
DE
313 g_clear_error(&error);
314
3250d8c7
BV
315 /* Add unitsize field. */
316 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
98654c99
DE
317 metabuf = g_key_file_to_data(kf, &metalen, NULL);
318 metasrc = zip_source_buffer(archive, metabuf, metalen, FALSE);
319
320 if (zip_replace(archive, zs.index, metasrc) < 0) {
321 sr_err("Failed to replace metadata: %s",
322 zip_strerror(archive));
323 g_key_file_free(kf);
324 zip_source_free(metasrc);
325 zip_discard(archive);
326 g_free(metabuf);
3250d8c7
BV
327 return SR_ERR;
328 }
3250d8c7
BV
329 }
330 g_key_file_free(kf);
331
332 next_chunk_num = 1;
333 num_files = zip_get_num_entries(archive, 0);
334 for (i = 0; i < num_files; i++) {
335 entry_name = zip_get_name(archive, i, 0);
98654c99 336 if (!entry_name || strncmp(entry_name, "logic-1", 7) != 0)
3250d8c7 337 continue;
98654c99 338 if (entry_name[7] == '\0') {
faf6dc46
UH
339 /*
340 * This file has no extra chunks, just a single
341 * "logic-1". Rename it to "logic-1-1" and continue
342 * with chunk 2.
343 */
98654c99
DE
344 if (zip_rename(archive, i, "logic-1-1") < 0) {
345 sr_err("Failed to rename 'logic-1' to 'logic-1-1': %s",
346 zip_strerror(archive));
347 zip_discard(archive);
348 g_free(metabuf);
3250d8c7
BV
349 return SR_ERR;
350 }
351 next_chunk_num = 2;
352 break;
98654c99
DE
353 } else if (entry_name[7] == '-') {
354 chunk_num = g_ascii_strtoull(entry_name + 8, NULL, 10);
355 if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
3250d8c7
BV
356 next_chunk_num = chunk_num + 1;
357 }
358 }
98654c99
DE
359
360 if (length % unitsize != 0) {
c03aaf34
GS
361 sr_warn("Chunk size %zu not a multiple of the"
362 " unit size %zu.", length, unitsize);
3250d8c7 363 }
98654c99
DE
364 logicsrc = zip_source_buffer(archive, buf, length, FALSE);
365 chunkname = g_strdup_printf("logic-1-%u", next_chunk_num);
366 i = zip_add(archive, chunkname, logicsrc);
367 g_free(chunkname);
368 if (i < 0) {
369 sr_err("Failed to add chunk 'logic-1-%u': %s",
370 next_chunk_num, zip_strerror(archive));
371 zip_source_free(logicsrc);
372 zip_discard(archive);
373 g_free(metabuf);
3250d8c7
BV
374 return SR_ERR;
375 }
98654c99
DE
376 if (zip_close(archive) < 0) {
377 sr_err("Error saving session file: %s", zip_strerror(archive));
378 zip_discard(archive);
379 g_free(metabuf);
3250d8c7
BV
380 return SR_ERR;
381 }
98654c99 382 g_free(metabuf);
3250d8c7
BV
383
384 return SR_OK;
385}
386
c03aaf34
GS
387/**
388 * Queue a block of logic data for srzip archive writes.
389 *
390 * @param[in] o Output module instance.
391 * @param[in] buf Logic data samples as byte sequence.
392 * @param[in] unitsize Logic data unit size (bytes per sample).
393 * @param[in] length Number of bytes of sample data.
394 * @param[in] flush Force ZIP archive update (queue by default).
395 *
396 * @returns SR_OK et al error codes.
397 */
398static int zip_append_queue(const struct sr_output *o,
5c52d96a 399 const uint8_t *buf, size_t feed_unitsize, size_t length,
e4cfebe0 400 gboolean flush)
c03aaf34 401{
5c52d96a
GS
402 static gboolean sizes_seen;
403
c03aaf34
GS
404 struct out_context *outc;
405 struct logic_buff *buff;
5c52d96a 406 size_t sample_copy_size, sample_skip_size, sample_pad_size;
7bf35e65 407 size_t send_count, remain, copy_count;
201bd256
GS
408 const uint8_t *rdptr;
409 uint8_t *wrptr;
c03aaf34
GS
410 int ret;
411
5c52d96a
GS
412 /*
413 * Check input parameters. Prepare to either grab data as is,
414 * or to adjust between differing input and output unit sizes.
415 * Diagnostics is rate limited for improved usability, assumes
416 * that session feeds are consistent across calls. Processing
417 * would cope with inconsistent calls though when required.
418 */
c03aaf34
GS
419 outc = o->priv;
420 buff = &outc->logic_buff;
5c52d96a
GS
421 if (length) {
422 if (!sizes_seen) {
423 sr_info("output unit size %zu, feed unit size %zu.",
424 buff->zip_unit_size, feed_unitsize);
425 }
426 if (feed_unitsize > buff->zip_unit_size) {
427 if (!sizes_seen)
428 sr_info("Large unit size, discarding excess logic data.");
429 sample_copy_size = buff->zip_unit_size;
430 sample_skip_size = feed_unitsize - buff->zip_unit_size;
431 sample_pad_size = 0;
432 } else if (feed_unitsize < buff->zip_unit_size) {
433 if (!sizes_seen)
434 sr_info("Small unit size, padding logic data.");
435 sample_copy_size = feed_unitsize;
436 sample_skip_size = 0;
437 sample_pad_size = buff->zip_unit_size - feed_unitsize;
438 } else {
439 if (!sizes_seen)
440 sr_dbg("Matching unit size, passing logic data as is.");
441 sample_copy_size = buff->zip_unit_size;
442 sample_skip_size = 0;
443 sample_pad_size = 0;
444 }
445 if (sample_copy_size + sample_skip_size != feed_unitsize) {
446 sr_err("Inconsistent input unit size. Implementation flaw?");
447 return SR_ERR_BUG;
448 }
449 if (sample_copy_size + sample_pad_size != buff->zip_unit_size) {
450 sr_err("Inconsistent output unit size. Implementation flaw?");
451 return SR_ERR_BUG;
452 }
453 sizes_seen = TRUE;
9dde7460 454 }
c03aaf34
GS
455
456 /*
457 * Queue most recently received samples to the local buffer.
458 * Flush to the ZIP archive when the buffer space is exhausted.
459 */
460 rdptr = buf;
5c52d96a 461 send_count = feed_unitsize ? length / feed_unitsize : 0;
7bf35e65 462 while (send_count) {
c03aaf34
GS
463 remain = buff->alloc_size - buff->fill_size;
464 if (remain) {
e4cfebe0 465 wrptr = &buff->samples[buff->fill_size * buff->zip_unit_size];
7bf35e65 466 copy_count = MIN(send_count, remain);
5c52d96a
GS
467 if (sample_skip_size || sample_pad_size)
468 copy_count = 1;
7bf35e65
GS
469 send_count -= copy_count;
470 buff->fill_size += copy_count;
5c52d96a
GS
471 memcpy(wrptr, rdptr, copy_count * sample_copy_size);
472 if (sample_pad_size) {
473 wrptr += sample_copy_size;
474 memset(wrptr, 0, sample_pad_size);
475 }
476 rdptr += copy_count * sample_copy_size;
477 if (sample_skip_size)
478 rdptr += sample_skip_size;
7bf35e65 479 remain -= copy_count;
c03aaf34 480 }
7bf35e65 481 if (send_count && !remain) {
e4cfebe0
GS
482 ret = zip_append(o, buff->samples, buff->zip_unit_size,
483 buff->fill_size * buff->zip_unit_size);
c03aaf34
GS
484 if (ret != SR_OK)
485 return ret;
486 buff->fill_size = 0;
487 remain = buff->alloc_size - buff->fill_size;
488 }
489 }
490
491 /* Flush to the ZIP archive if the caller wants us to. */
492 if (flush && buff->fill_size) {
e4cfebe0
GS
493 ret = zip_append(o, buff->samples, buff->zip_unit_size,
494 buff->fill_size * buff->zip_unit_size);
c03aaf34
GS
495 if (ret != SR_OK)
496 return ret;
497 buff->fill_size = 0;
498 }
499
500 return SR_OK;
501}
502
503/**
504 * Append analog data of a channel to an srzip archive.
505 *
506 * @param[in] o Output module instance.
507 * @param[in] values Sample data as array of floating point values.
508 * @param[in] count Number of samples (float items, not bytes).
509 * @param[in] ch_nr 1-based channel number.
510 *
511 * @returns SR_OK et al error codes.
512 */
7163dcbe 513static int zip_append_analog(const struct sr_output *o,
c03aaf34 514 const float *values, size_t count, size_t ch_nr)
7163dcbe
ML
515{
516 struct out_context *outc;
517 struct zip *archive;
518 struct zip_source *analogsrc;
519 int64_t i, num_files;
c03aaf34 520 size_t size;
7163dcbe
ML
521 struct zip_stat zs;
522 uint64_t chunk_num;
523 const char *entry_name;
524 char *basename;
525 gsize baselen;
7163dcbe 526 char *chunkname;
c03aaf34 527 unsigned int next_chunk_num;
7163dcbe
ML
528
529 outc = o->priv;
7163dcbe 530
7e2f4221
LPC
531 if (!(archive = zip_open(outc->filename, 0, NULL)))
532 return SR_ERR;
533
534 if (zip_stat(archive, "metadata", 0, &zs) < 0) {
535 sr_err("Failed to open metadata: %s", zip_strerror(archive));
c03aaf34
GS
536 zip_discard(archive);
537 return SR_ERR;
7e2f4221
LPC
538 }
539
c03aaf34 540 basename = g_strdup_printf("analog-1-%zu", ch_nr);
7163dcbe
ML
541 baselen = strlen(basename);
542 next_chunk_num = 1;
543 num_files = zip_get_num_entries(archive, 0);
544 for (i = 0; i < num_files; i++) {
545 entry_name = zip_get_name(archive, i, 0);
546 if (!entry_name || strncmp(entry_name, basename, baselen) != 0) {
547 continue;
548 } else if (entry_name[baselen] == '-') {
549 chunk_num = g_ascii_strtoull(entry_name + baselen + 1, NULL, 10);
550 if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
551 next_chunk_num = chunk_num + 1;
552 }
553 }
554
c03aaf34
GS
555 size = sizeof(values[0]) * count;
556 analogsrc = zip_source_buffer(archive, values, size, FALSE);
7163dcbe
ML
557 chunkname = g_strdup_printf("%s-%u", basename, next_chunk_num);
558 i = zip_add(archive, chunkname, analogsrc);
7163dcbe
ML
559 if (i < 0) {
560 sr_err("Failed to add chunk '%s': %s", chunkname, zip_strerror(archive));
d3ec7035 561 g_free(chunkname);
c03aaf34 562 g_free(basename);
7163dcbe 563 zip_source_free(analogsrc);
c03aaf34
GS
564 zip_discard(archive);
565 return SR_ERR;
7163dcbe 566 }
d3ec7035 567 g_free(chunkname);
7163dcbe
ML
568 if (zip_close(archive) < 0) {
569 sr_err("Error saving session file: %s", zip_strerror(archive));
c03aaf34
GS
570 g_free(basename);
571 zip_discard(archive);
572 return SR_ERR;
7163dcbe
ML
573 }
574
7e2f4221 575 g_free(basename);
7e2f4221 576
7163dcbe 577 return SR_OK;
c03aaf34 578}
7e2f4221 579
c03aaf34
GS
580/**
581 * Queue analog data of a channel for srzip archive writes.
582 *
583 * @param[in] o Output module instance.
584 * @param[in] analog Sample data (session feed packet format).
585 * @param[in] flush Force ZIP archive update (queue by default).
586 *
587 * @returns SR_OK et al error codes.
588 */
589static int zip_append_analog_queue(const struct sr_output *o,
590 const struct sr_datafeed_analog *analog, gboolean flush)
591{
592 struct out_context *outc;
593 const struct sr_channel *ch;
594 size_t idx, nr;
595 struct analog_buff *buff;
596 float *values, *wrptr, *rdptr;
597 size_t send_size, remain, copy_size;
598 int ret;
7e2f4221 599
c03aaf34
GS
600 outc = o->priv;
601
602 /* Is this the DF_END flush call without samples submission? */
603 if (!analog && flush) {
604 for (idx = 0; idx < outc->analog_ch_count; idx++) {
605 nr = outc->first_analog_index + idx;
606 buff = &outc->analog_buff[idx];
607 if (!buff->fill_size)
608 continue;
609 ret = zip_append_analog(o,
610 buff->samples, buff->fill_size, nr);
611 if (ret != SR_OK)
612 return ret;
613 buff->fill_size = 0;
614 }
615 return SR_OK;
616 }
617
618 /* Lookup index and number of the analog channel. */
619 /* TODO: support packets covering multiple channels */
620 if (g_slist_length(analog->meaning->channels) != 1) {
621 sr_err("Analog packets covering multiple channels not supported yet");
622 return SR_ERR;
623 }
624 ch = g_slist_nth_data(analog->meaning->channels, 0);
625 for (idx = 0; idx < outc->analog_ch_count; idx++) {
626 if (outc->analog_index_map[idx] == ch->index)
627 break;
628 }
629 if (idx == outc->analog_ch_count)
630 return SR_ERR_ARG;
631 nr = outc->first_analog_index + idx;
632 buff = &outc->analog_buff[idx];
633
634 /* Convert the analog data to an array of float values. */
635 values = g_try_malloc0(analog->num_samples * sizeof(values[0]));
636 if (!values)
637 return SR_ERR_MALLOC;
638 ret = sr_analog_to_float(analog, values);
639 if (ret != SR_OK) {
640 g_free(values);
641 return ret;
642 }
643
644 /*
645 * Queue most recently received samples to the local buffer.
646 * Flush to the ZIP archive when the buffer space is exhausted.
647 */
648 rdptr = values;
649 send_size = analog->num_samples;
650 while (send_size) {
651 remain = buff->alloc_size - buff->fill_size;
652 if (remain) {
653 wrptr = &buff->samples[buff->fill_size];
654 copy_size = MIN(send_size, remain);
655 send_size -= copy_size;
656 buff->fill_size += copy_size;
657 memcpy(wrptr, rdptr, copy_size * sizeof(values[0]));
658 rdptr += copy_size;
659 remain -= copy_size;
660 }
661 if (send_size && !remain) {
662 ret = zip_append_analog(o,
663 buff->samples, buff->fill_size, nr);
664 if (ret != SR_OK) {
665 g_free(values);
666 return ret;
667 }
668 buff->fill_size = 0;
669 remain = buff->alloc_size - buff->fill_size;
670 }
671 }
672 g_free(values);
673
674 /* Flush to the ZIP archive if the caller wants us to. */
675 if (flush && buff->fill_size) {
676 ret = zip_append_analog(o, buff->samples, buff->fill_size, nr);
677 if (ret != SR_OK)
678 return ret;
679 buff->fill_size = 0;
680 }
681
682 return SR_OK;
7163dcbe
ML
683}
684
3250d8c7
BV
685static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
686 GString **out)
687{
688 struct out_context *outc;
689 const struct sr_datafeed_meta *meta;
690 const struct sr_datafeed_logic *logic;
7163dcbe 691 const struct sr_datafeed_analog *analog;
3250d8c7
BV
692 const struct sr_config *src;
693 GSList *l;
3250d8c7
BV
694 int ret;
695
696 *out = NULL;
697 if (!o || !o->sdi || !(outc = o->priv))
698 return SR_ERR_ARG;
699
700 switch (packet->type) {
701 case SR_DF_META:
702 meta = packet->payload;
703 for (l = meta->config; l; l = l->next) {
704 src = l->data;
705 if (src->key != SR_CONF_SAMPLERATE)
706 continue;
707 outc->samplerate = g_variant_get_uint64(src->data);
708 }
709 break;
710 case SR_DF_LOGIC:
711 if (!outc->zip_created) {
712 if ((ret = zip_create(o)) != SR_OK)
713 return ret;
714 outc->zip_created = TRUE;
715 }
716 logic = packet->payload;
e4cfebe0
GS
717 ret = zip_append_queue(o,
718 logic->data, logic->unitsize, logic->length,
719 FALSE);
e57057ae
UH
720 if (ret != SR_OK)
721 return ret;
3250d8c7 722 break;
7163dcbe
ML
723 case SR_DF_ANALOG:
724 if (!outc->zip_created) {
725 if ((ret = zip_create(o)) != SR_OK)
726 return ret;
727 outc->zip_created = TRUE;
728 }
729 analog = packet->payload;
c03aaf34 730 ret = zip_append_analog_queue(o, analog, FALSE);
7163dcbe
ML
731 if (ret != SR_OK)
732 return ret;
733 break;
c03aaf34
GS
734 case SR_DF_END:
735 if (outc->zip_created) {
736 ret = zip_append_queue(o, NULL, 0, 0, TRUE);
737 if (ret != SR_OK)
738 return ret;
739 ret = zip_append_analog_queue(o, NULL, TRUE);
740 if (ret != SR_OK)
741 return ret;
742 }
743 break;
3250d8c7
BV
744 }
745
746 return SR_OK;
747}
748
3250d8c7 749static struct sr_option options[] = {
3250d8c7
BV
750 ALL_ZERO
751};
752
753static const struct sr_option *get_options(void)
754{
3250d8c7
BV
755 return options;
756}
757
da3d141f
SB
758static int cleanup(struct sr_output *o)
759{
760 struct out_context *outc;
c03aaf34 761 size_t idx;
da3d141f
SB
762
763 outc = o->priv;
c03aaf34 764
0586a0ef 765 g_free(outc->analog_index_map);
da3d141f 766 g_free(outc->filename);
c03aaf34
GS
767 g_free(outc->logic_buff.samples);
768 for (idx = 0; idx < outc->analog_ch_count; idx++)
769 g_free(outc->analog_buff[idx].samples);
770 g_free(outc->analog_buff);
771
da3d141f
SB
772 g_free(outc);
773 o->priv = NULL;
774
775 return SR_OK;
776}
777
3250d8c7
BV
778SR_PRIV struct sr_output_module output_srzip = {
779 .id = "srzip",
780 .name = "srzip",
b20eb520 781 .desc = "srzip session file format data",
8a174d23 782 .exts = (const char*[]){"sr", NULL},
3cd4b381 783 .flags = SR_OUTPUT_INTERNAL_IO_HANDLING,
3250d8c7
BV
784 .options = get_options,
785 .init = init,
786 .receive = receive,
787 .cleanup = cleanup,
788};