[libsigrok.git] / src / output / srzip.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <zip.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "output/srzip"

struct out_context {
	gboolean zip_created;
	uint64_t samplerate;
	char *filename;
	gint first_analog_index;
	gint *analog_index_map;
};

static int init(struct sr_output *o, GHashTable *options)
{
	struct out_context *outc;

	(void)options;

	if (!o->filename || o->filename[0] == '\0') {
		sr_info("srzip output module requires a file name, cannot save.");
		return SR_ERR_ARG;
	}

	outc = g_malloc0(sizeof(struct out_context));
	outc->filename = g_strdup(o->filename);
	o->priv = outc;

	return SR_OK;
}

static int zip_create(const struct sr_output *o)
{
	struct out_context *outc;
	struct zip *zipfile;
	struct zip_source *versrc, *metasrc;
	struct sr_channel *ch;
	GVariant *gvar;
	GKeyFile *meta;
	GSList *l;
	const char *devgroup;
	char *s, *metabuf;
	gsize metalen;
	guint logic_channels = 0, enabled_logic_channels = 0;
	guint enabled_analog_channels = 0;
	guint index;

	outc = o->priv;

	if (outc->samplerate == 0 && sr_config_get(o->sdi->driver, o->sdi, NULL,
					SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
		outc->samplerate = g_variant_get_uint64(gvar);
		g_variant_unref(gvar);
	}

	/* Quietly delete it first, libzip wants replace ops otherwise. */
	g_unlink(outc->filename);
	zipfile = zip_open(outc->filename, ZIP_CREATE, NULL);
	if (!zipfile)
		return SR_ERR;

	/* "version" */
	versrc = zip_source_buffer(zipfile, "2", 1, FALSE);
	if (zip_add(zipfile, "version", versrc) < 0) {
		sr_err("Error saving version into zipfile: %s",
			zip_strerror(zipfile));
		zip_source_free(versrc);
		zip_discard(zipfile);
		return SR_ERR;
	}

	/* init "metadata" */
	meta = g_key_file_new();

	g_key_file_set_string(meta, "global", "sigrok version",
			SR_PACKAGE_VERSION_STRING);

	devgroup = "device 1";

	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;

		switch (ch->type) {
		case SR_CHANNEL_LOGIC:
			if (ch->enabled)
				enabled_logic_channels++;
			logic_channels++;
			break;
		case SR_CHANNEL_ANALOG:
			if (ch->enabled)
				enabled_analog_channels++;
			break;
		}
	}

	/* When reading the file, the first index of the analog channels
	 * can only be deduced through the "total probes" count, so the
	 * first analog index must follow the last logic one, enabled or not. */
	if (enabled_logic_channels > 0)
		outc->first_analog_index = logic_channels + 1;
	else
		outc->first_analog_index = 1;

	/* Only set capturefile and probes if we will actually save logic data. */
	if (enabled_logic_channels > 0) {
		g_key_file_set_string(meta, devgroup, "capturefile", "logic-1");
		g_key_file_set_integer(meta, devgroup, "total probes", logic_channels);
	}

	s = sr_samplerate_string(outc->samplerate);
	g_key_file_set_string(meta, devgroup, "samplerate", s);
	g_free(s);

	g_key_file_set_integer(meta, devgroup, "total analog", enabled_analog_channels);

	/* Make the array one entry larger than needed so we can use the final
	 * 0 as terminator. */
	outc->analog_index_map = g_malloc0(sizeof(gint) * (enabled_analog_channels + 1));

	index = 0;
	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;
		if (!ch->enabled)
			continue;

		switch (ch->type) {
		case SR_CHANNEL_LOGIC:
			s = g_strdup_printf("probe%d", ch->index + 1);
			break;
		case SR_CHANNEL_ANALOG:
			outc->analog_index_map[index] = ch->index;
			s = g_strdup_printf("analog%d", outc->first_analog_index + index);
			index++;
			break;
		}
		g_key_file_set_string(meta, devgroup, s, ch->name);
		g_free(s);
	}

	metabuf = g_key_file_to_data(meta, &metalen, NULL);
	g_key_file_free(meta);

	metasrc = zip_source_buffer(zipfile, metabuf, metalen, FALSE);
	if (zip_add(zipfile, "metadata", metasrc) < 0) {
		sr_err("Error saving metadata into zipfile: %s",
			zip_strerror(zipfile));
		zip_source_free(metasrc);
		zip_discard(zipfile);
		g_free(metabuf);
		return SR_ERR;
	}

	if (zip_close(zipfile) < 0) {
		sr_err("Error saving zipfile: %s", zip_strerror(zipfile));
		zip_discard(zipfile);
		g_free(metabuf);
		return SR_ERR;
	}
	g_free(metabuf);

	return SR_OK;
}

static int zip_append(const struct sr_output *o, unsigned char *buf,
		int unitsize, int length)
{
	struct out_context *outc;
	struct zip *archive;
	struct zip_source *logicsrc;
	int64_t i, num_files;
	struct zip_stat zs;
	struct zip_source *metasrc;
	GKeyFile *kf;
	GError *error;
	uint64_t chunk_num;
	const char *entry_name;
	char *metabuf;
	gsize metalen;
	char *chunkname;
	unsigned int next_chunk_num;

	outc = o->priv;
	if (!(archive = zip_open(outc->filename, 0, NULL)))
		return SR_ERR;

	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
		sr_err("Failed to open metadata: %s", zip_strerror(archive));
		zip_discard(archive);
		return SR_ERR;
	}
	kf = sr_sessionfile_read_metadata(archive, &zs);
	if (!kf) {
		zip_discard(archive);
		return SR_ERR_DATA;
	}
	/*
	 * If the file was only initialized but doesn't yet have any
	 * data it in, it won't have a unitsize field in metadata yet.
	 */
	error = NULL;
	metabuf = NULL;
	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
		if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
			sr_err("Failed to check unitsize key: %s", error->message);
			g_error_free(error);
			g_key_file_free(kf);
			zip_discard(archive);
			return SR_ERR;
		}
		g_clear_error(&error);

		/* Add unitsize field. */
		g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
		metabuf = g_key_file_to_data(kf, &metalen, NULL);
		metasrc = zip_source_buffer(archive, metabuf, metalen, FALSE);

		if (zip_replace(archive, zs.index, metasrc) < 0) {
			sr_err("Failed to replace metadata: %s",
				zip_strerror(archive));
			g_key_file_free(kf);
			zip_source_free(metasrc);
			zip_discard(archive);
			g_free(metabuf);
			return SR_ERR;
		}
	}
	g_key_file_free(kf);

	next_chunk_num = 1;
	num_files = zip_get_num_entries(archive, 0);
	for (i = 0; i < num_files; i++) {
		entry_name = zip_get_name(archive, i, 0);
		if (!entry_name || strncmp(entry_name, "logic-1", 7) != 0)
			continue;
		if (entry_name[7] == '\0') {
			/* This file has no extra chunks, just a single "logic-1".
			 * Rename it to "logic-1-1" * and continue with chunk 2. */
			if (zip_rename(archive, i, "logic-1-1") < 0) {
				sr_err("Failed to rename 'logic-1' to 'logic-1-1': %s",
					zip_strerror(archive));
				zip_discard(archive);
				g_free(metabuf);
				return SR_ERR;
			}
			next_chunk_num = 2;
			break;
		} else if (entry_name[7] == '-') {
			chunk_num = g_ascii_strtoull(entry_name + 8, NULL, 10);
			if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
				next_chunk_num = chunk_num + 1;
		}
	}

	if (length % unitsize != 0) {
		sr_warn("Chunk size %d not a multiple of the"
			" unit size %d.", length, unitsize);
	}
	logicsrc = zip_source_buffer(archive, buf, length, FALSE);
	chunkname = g_strdup_printf("logic-1-%u", next_chunk_num);
	i = zip_add(archive, chunkname, logicsrc);
	g_free(chunkname);
	if (i < 0) {
		sr_err("Failed to add chunk 'logic-1-%u': %s",
			next_chunk_num, zip_strerror(archive));
		zip_source_free(logicsrc);
		zip_discard(archive);
		g_free(metabuf);
		return SR_ERR;
	}
	if (zip_close(archive) < 0) {
		sr_err("Error saving session file: %s", zip_strerror(archive));
		zip_discard(archive);
		g_free(metabuf);
		return SR_ERR;
	}
	g_free(metabuf);

	return SR_OK;
}

static int zip_append_analog(const struct sr_output *o,
		const struct sr_datafeed_analog *analog)
{
	struct out_context *outc;
	struct zip *archive;
	struct zip_source *analogsrc;
	int64_t i, num_files;
	struct zip_stat zs;
	uint64_t chunk_num;
	const char *entry_name;
	char *basename;
	gsize baselen;
	struct sr_channel *channel;
	float *chunkbuf;
	gsize chunksize;
	char *chunkname;
	unsigned int next_chunk_num, index;

	outc = o->priv;
	if (!(archive = zip_open(outc->filename, 0, NULL)))
		return SR_ERR;

	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
		sr_err("Failed to open metadata: %s", zip_strerror(archive));
		zip_discard(archive);
		return SR_ERR;
	}

	/* TODO: support packets covering multiple channels */
	if (g_slist_length(analog->meaning->channels) != 1) {
		sr_err("Analog packets covering multiple channels not supported yet");
		return SR_ERR;
	}
	channel = analog->meaning->channels->data;

	/* When reading the file, analog channels must be consecutive.
	 * Thus we need a global channel index map as we don't know in
	 * which order the channel data comes in. */
	for (index = 0; outc->analog_index_map[index]; index++)
		if (outc->analog_index_map[index] == channel->index)
			break;
	if (!outc->analog_index_map[index])
		return SR_ERR_ARG;  /* Channel index was not in the list */

	index += outc->first_analog_index;

	basename = g_strdup_printf("analog-1-%u", index);
	baselen = strlen(basename);
	next_chunk_num = 1;
	num_files = zip_get_num_entries(archive, 0);
	for (i = 0; i < num_files; i++) {
		entry_name = zip_get_name(archive, i, 0);
		if (!entry_name || strncmp(entry_name, basename, baselen) != 0) {
			continue;
		} else if (entry_name[baselen] == '-') {
			chunk_num = g_ascii_strtoull(entry_name + baselen + 1, NULL, 10);
			if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
				next_chunk_num = chunk_num + 1;
		}
	}

	chunksize = sizeof(float) * analog->num_samples;
	if (!(chunkbuf = g_try_malloc(chunksize)))
		return SR_ERR;
	if (sr_analog_to_float(analog, chunkbuf) != SR_OK)
		return SR_ERR;

	analogsrc = zip_source_buffer(archive, chunkbuf, chunksize, FALSE);
	chunkname = g_strdup_printf("%s-%u", basename, next_chunk_num);
	i = zip_add(archive, chunkname, analogsrc);
	g_free(chunkname);
	if (i < 0) {
		sr_err("Failed to add chunk '%s': %s", chunkname, zip_strerror(archive));
		zip_source_free(analogsrc);
		zip_discard(archive);
		return SR_ERR;
	}
	if (zip_close(archive) < 0) {
		sr_err("Error saving session file: %s", zip_strerror(archive));
		zip_discard(archive);
		return SR_ERR;
	}

	return SR_OK;
}

static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	struct out_context *outc;
	const struct sr_datafeed_meta *meta;
	const struct sr_datafeed_logic *logic;
	const struct sr_datafeed_analog *analog;
	const struct sr_config *src;
	GSList *l;

	int ret;

	*out = NULL;
	if (!o || !o->sdi || !(outc = o->priv))
		return SR_ERR_ARG;

	switch (packet->type) {
	case SR_DF_META:
		meta = packet->payload;
		for (l = meta->config; l; l = l->next) {
			src = l->data;
			if (src->key != SR_CONF_SAMPLERATE)
				continue;
			outc->samplerate = g_variant_get_uint64(src->data);
		}
		break;
	case SR_DF_LOGIC:
		if (!outc->zip_created) {
			if ((ret = zip_create(o)) != SR_OK)
				return ret;
			outc->zip_created = TRUE;
		}
		logic = packet->payload;
		ret = zip_append(o, logic->data, logic->unitsize, logic->length);
		if (ret != SR_OK)
			return ret;
		break;
	case SR_DF_ANALOG:
		if (!outc->zip_created) {
			if ((ret = zip_create(o)) != SR_OK)
				return ret;
			outc->zip_created = TRUE;
		}
		analog = packet->payload;
		ret = zip_append_analog(o, analog);
		if (ret != SR_OK)
			return ret;
		break;
	}

	return SR_OK;
}

static struct sr_option options[] = {
	ALL_ZERO
};

static const struct sr_option *get_options(void)
{
	if (!options[0].def)
		options[0].def = g_variant_ref_sink(g_variant_new_string(""));

	return options;
}

static int cleanup(struct sr_output *o)
{
	struct out_context *outc;

	outc = o->priv;
	g_variant_unref(options[0].def);
	g_free(outc->analog_index_map);
	g_free(outc->filename);
	g_free(outc);
	o->priv = NULL;

	return SR_OK;
}

SR_PRIV struct sr_output_module output_srzip = {
	.id = "srzip",
	.name = "srzip",
	.desc = "srzip session file",
	.exts = (const char*[]){"sr", NULL},
	.flags = SR_OUTPUT_INTERNAL_IO_HANDLING,
	.options = get_options,
	.init = init,
	.receive = receive,
	.cleanup = cleanup,
};
Commit	Line	Data
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"
	31
	32	struct out_context {
	33	gboolean zip_created;
	34	uint64_t samplerate;
	35	char *filename;
0586a0ef SA	36	gint first_analog_index;
0586a0ef SA	37	gint *analog_index_map;
3250d8c7 BV	38	};
	39
	40	static int init(struct sr_output o, GHashTable options)
	41	{
	42	struct out_context *outc;
	43
37875f75 SA	44	(void)options;
37875f75 SA	45
98654c99	46	if (!o->filename \|\| o->filename[0] == '\0') {
37875f75	47	sr_info("srzip output module requires a file name, cannot save.");
3250d8c7	48	return SR_ERR_ARG;
37875f75	49	}
7df31ae8 SA	50
7df31ae8 SA	51	outc = g_malloc0(sizeof(struct out_context));
37875f75	52	outc->filename = g_strdup(o->filename);
7df31ae8	53	o->priv = outc;
3250d8c7 BV	54
	55	return SR_OK;
	56	}
	57
	58	static int zip_create(const struct sr_output *o)
	59	{
	60	struct out_context *outc;
3250d8c7 BV	61	struct zip *zipfile;
3250d8c7 BV	62	struct zip_source versrc, metasrc;
98654c99	63	struct sr_channel *ch;
3250d8c7	64	GVariant *gvar;
98654c99	65	GKeyFile *meta;
3250d8c7	66	GSList *l;
98654c99 DE	67	const char *devgroup;
	68	char s, metabuf;
	69	gsize metalen;
0586a0ef SA	70	guint logic_channels = 0, enabled_logic_channels = 0;
	71	guint enabled_analog_channels = 0;
	72	guint index;
3250d8c7 BV	73
3250d8c7 BV	74	outc = o->priv;
98654c99 DE	75
	76	if (outc->samplerate == 0 && sr_config_get(o->sdi->driver, o->sdi, NULL,
	77	SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
	78	outc->samplerate = g_variant_get_uint64(gvar);
	79	g_variant_unref(gvar);
3250d8c7 BV	80	}
	81
	82	/* Quietly delete it first, libzip wants replace ops otherwise. */
98654c99 DE	83	g_unlink(outc->filename);
	84	zipfile = zip_open(outc->filename, ZIP_CREATE, NULL);
	85	if (!zipfile)
3250d8c7 BV	86	return SR_ERR;
	87
	88	/* "version" */
98654c99	89	versrc = zip_source_buffer(zipfile, "2", 1, FALSE);
eaa6a7a3	90	if (zip_add(zipfile, "version", versrc) < 0) {
98654c99	91	sr_err("Error saving version into zipfile: %s",
3250d8c7	92	zip_strerror(zipfile));
98654c99 DE	93	zip_source_free(versrc);
98654c99 DE	94	zip_discard(zipfile);
3250d8c7 BV	95	return SR_ERR;
	96	}
	97
	98	/* init "metadata" */
98654c99 DE	99	meta = g_key_file_new();
	100
	101	g_key_file_set_string(meta, "global", "sigrok version",
	102	SR_PACKAGE_VERSION_STRING);
	103
	104	devgroup = "device 1";
26918dce	105
82883219 ML	106	for (l = o->sdi->channels; l; l = l->next) {
82883219 ML	107	ch = l->data;
0586a0ef	108
eab05299	109	switch (ch->type) {
74a9c0ad	110	case SR_CHANNEL_LOGIC:
0586a0ef SA	111	if (ch->enabled)
0586a0ef SA	112	enabled_logic_channels++;
74a9c0ad UH	113	logic_channels++;
	114	break;
	115	case SR_CHANNEL_ANALOG:
0586a0ef SA	116	if (ch->enabled)
0586a0ef SA	117	enabled_analog_channels++;
74a9c0ad	118	break;
eab05299	119	}
82883219 ML	120	}
82883219 ML	121
0586a0ef SA	122	/* When reading the file, the first index of the analog channels
	123	* can only be deduced through the "total probes" count, so the
	124	* first analog index must follow the last logic one, enabled or not. */
	125	if (enabled_logic_channels > 0)
	126	outc->first_analog_index = logic_channels + 1;
	127	else
	128	outc->first_analog_index = 1;
	129
	130	/* Only set capturefile and probes if we will actually save logic data. */
	131	if (enabled_logic_channels > 0) {
	132	g_key_file_set_string(meta, devgroup, "capturefile", "logic-1");
	133	g_key_file_set_integer(meta, devgroup, "total probes", logic_channels);
	134	}
	135
	136	s = sr_samplerate_string(outc->samplerate);
	137	g_key_file_set_string(meta, devgroup, "samplerate", s);
	138	g_free(s);
	139
	140	g_key_file_set_integer(meta, devgroup, "total analog", enabled_analog_channels);
e5b280e4	141
0586a0ef SA	142	/* Make the array one entry larger than needed so we can use the final
	143	* 0 as terminator. */
	144	outc->analog_index_map = g_malloc0(sizeof(gint) * (enabled_analog_channels + 1));
82883219	145
0586a0ef	146	index = 0;
3250d8c7 BV	147	for (l = o->sdi->channels; l; l = l->next) {
3250d8c7 BV	148	ch = l->data;
0586a0ef SA	149	if (!ch->enabled)
	150	continue;
	151
eab05299	152	switch (ch->type) {
74a9c0ad UH	153	case SR_CHANNEL_LOGIC:
	154	s = g_strdup_printf("probe%d", ch->index + 1);
	155	break;
	156	case SR_CHANNEL_ANALOG:
0586a0ef SA	157	outc->analog_index_map[index] = ch->index;
	158	s = g_strdup_printf("analog%d", outc->first_analog_index + index);
	159	index++;
74a9c0ad	160	break;
98654c99	161	}
0586a0ef	162	g_key_file_set_string(meta, devgroup, s, ch->name);
eab05299	163	g_free(s);
3250d8c7	164	}
82883219	165
98654c99 DE	166	metabuf = g_key_file_to_data(meta, &metalen, NULL);
98654c99 DE	167	g_key_file_free(meta);
3250d8c7	168
98654c99	169	metasrc = zip_source_buffer(zipfile, metabuf, metalen, FALSE);
eaa6a7a3	170	if (zip_add(zipfile, "metadata", metasrc) < 0) {
98654c99 DE	171	sr_err("Error saving metadata into zipfile: %s",
	172	zip_strerror(zipfile));
	173	zip_source_free(metasrc);
	174	zip_discard(zipfile);
	175	g_free(metabuf);
3250d8c7 BV	176	return SR_ERR;
	177	}
	178
98654c99 DE	179	if (zip_close(zipfile) < 0) {
	180	sr_err("Error saving zipfile: %s", zip_strerror(zipfile));
	181	zip_discard(zipfile);
	182	g_free(metabuf);
3250d8c7 BV	183	return SR_ERR;
3250d8c7 BV	184	}
98654c99	185	g_free(metabuf);
3250d8c7 BV	186
	187	return SR_OK;
	188	}
	189
	190	static int zip_append(const struct sr_output o, unsigned char buf,
	191	int unitsize, int length)
	192	{
	193	struct out_context *outc;
	194	struct zip *archive;
	195	struct zip_source *logicsrc;
98654c99	196	int64_t i, num_files;
3250d8c7 BV	197	struct zip_stat zs;
	198	struct zip_source *metasrc;
	199	GKeyFile *kf;
	200	GError *error;
98654c99	201	uint64_t chunk_num;
3250d8c7	202	const char *entry_name;
98654c99 DE	203	char *metabuf;
	204	gsize metalen;
	205	char *chunkname;
	206	unsigned int next_chunk_num;
3250d8c7 BV	207
3250d8c7 BV	208	outc = o->priv;
98654c99	209	if (!(archive = zip_open(outc->filename, 0, NULL)))
3250d8c7 BV	210	return SR_ERR;
3250d8c7 BV	211
98654c99 DE	212	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
	213	sr_err("Failed to open metadata: %s", zip_strerror(archive));
	214	zip_discard(archive);
3250d8c7	215	return SR_ERR;
98654c99 DE	216	}
	217	kf = sr_sessionfile_read_metadata(archive, &zs);
	218	if (!kf) {
	219	zip_discard(archive);
	220	return SR_ERR_DATA;
	221	}
3250d8c7 BV	222	/*
	223	* If the file was only initialized but doesn't yet have any
	224	* data it in, it won't have a unitsize field in metadata yet.
	225	*/
	226	error = NULL;
98654c99	227	metabuf = NULL;
3250d8c7 BV	228	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
3250d8c7 BV	229	if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
98654c99 DE	230	sr_err("Failed to check unitsize key: %s", error->message);
	231	g_error_free(error);
	232	g_key_file_free(kf);
	233	zip_discard(archive);
3250d8c7 BV	234	return SR_ERR;
3250d8c7 BV	235	}
98654c99 DE	236	g_clear_error(&error);
98654c99 DE	237
3250d8c7 BV	238	/* Add unitsize field. */
3250d8c7 BV	239	g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
98654c99 DE	240	metabuf = g_key_file_to_data(kf, &metalen, NULL);
	241	metasrc = zip_source_buffer(archive, metabuf, metalen, FALSE);
	242
	243	if (zip_replace(archive, zs.index, metasrc) < 0) {
	244	sr_err("Failed to replace metadata: %s",
	245	zip_strerror(archive));
	246	g_key_file_free(kf);
	247	zip_source_free(metasrc);
	248	zip_discard(archive);
	249	g_free(metabuf);
3250d8c7 BV	250	return SR_ERR;
3250d8c7 BV	251	}
3250d8c7 BV	252	}
	253	g_key_file_free(kf);
	254
	255	next_chunk_num = 1;
	256	num_files = zip_get_num_entries(archive, 0);
	257	for (i = 0; i < num_files; i++) {
	258	entry_name = zip_get_name(archive, i, 0);
98654c99	259	if (!entry_name \|\| strncmp(entry_name, "logic-1", 7) != 0)
3250d8c7	260	continue;
98654c99	261	if (entry_name[7] == '\0') {
3250d8c7 BV	262	/* This file has no extra chunks, just a single "logic-1".
3250d8c7 BV	263	* Rename it to "logic-1-1" * and continue with chunk 2. */
98654c99 DE	264	if (zip_rename(archive, i, "logic-1-1") < 0) {
	265	sr_err("Failed to rename 'logic-1' to 'logic-1-1': %s",
	266	zip_strerror(archive));
	267	zip_discard(archive);
	268	g_free(metabuf);
3250d8c7 BV	269	return SR_ERR;
	270	}
	271	next_chunk_num = 2;
	272	break;
98654c99 DE	273	} else if (entry_name[7] == '-') {
	274	chunk_num = g_ascii_strtoull(entry_name + 8, NULL, 10);
	275	if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
3250d8c7 BV	276	next_chunk_num = chunk_num + 1;
	277	}
	278	}
98654c99 DE	279
	280	if (length % unitsize != 0) {
	281	sr_warn("Chunk size %d not a multiple of the"
	282	" unit size %d.", length, unitsize);
3250d8c7	283	}
98654c99 DE	284	logicsrc = zip_source_buffer(archive, buf, length, FALSE);
	285	chunkname = g_strdup_printf("logic-1-%u", next_chunk_num);
	286	i = zip_add(archive, chunkname, logicsrc);
	287	g_free(chunkname);
	288	if (i < 0) {
	289	sr_err("Failed to add chunk 'logic-1-%u': %s",
	290	next_chunk_num, zip_strerror(archive));
	291	zip_source_free(logicsrc);
	292	zip_discard(archive);
	293	g_free(metabuf);
3250d8c7 BV	294	return SR_ERR;
3250d8c7 BV	295	}
98654c99 DE	296	if (zip_close(archive) < 0) {
	297	sr_err("Error saving session file: %s", zip_strerror(archive));
	298	zip_discard(archive);
	299	g_free(metabuf);
3250d8c7 BV	300	return SR_ERR;
3250d8c7 BV	301	}
98654c99	302	g_free(metabuf);
3250d8c7 BV	303
	304	return SR_OK;
	305	}
	306
7163dcbe ML	307	static int zip_append_analog(const struct sr_output *o,
	308	const struct sr_datafeed_analog *analog)
	309	{
	310	struct out_context *outc;
	311	struct zip *archive;
	312	struct zip_source *analogsrc;
	313	int64_t i, num_files;
	314	struct zip_stat zs;
	315	uint64_t chunk_num;
	316	const char *entry_name;
	317	char *basename;
	318	gsize baselen;
	319	struct sr_channel *channel;
	320	float *chunkbuf;
	321	gsize chunksize;
	322	char *chunkname;
0586a0ef	323	unsigned int next_chunk_num, index;
7163dcbe ML	324
	325	outc = o->priv;
	326	if (!(archive = zip_open(outc->filename, 0, NULL)))
	327	return SR_ERR;
	328
	329	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
	330	sr_err("Failed to open metadata: %s", zip_strerror(archive));
	331	zip_discard(archive);
	332	return SR_ERR;
	333	}
	334
	335	/* TODO: support packets covering multiple channels */
	336	if (g_slist_length(analog->meaning->channels) != 1) {
	337	sr_err("Analog packets covering multiple channels not supported yet");
	338	return SR_ERR;
	339	}
	340	channel = analog->meaning->channels->data;
	341
0586a0ef SA	342	/* When reading the file, analog channels must be consecutive.
	343	* Thus we need a global channel index map as we don't know in
	344	* which order the channel data comes in. */
	345	for (index = 0; outc->analog_index_map[index]; index++)
	346	if (outc->analog_index_map[index] == channel->index)
	347	break;
	348	if (!outc->analog_index_map[index])
	349	return SR_ERR_ARG; /* Channel index was not in the list */
	350
	351	index += outc->first_analog_index;
	352
	353	basename = g_strdup_printf("analog-1-%u", index);
7163dcbe ML	354	baselen = strlen(basename);
	355	next_chunk_num = 1;
	356	num_files = zip_get_num_entries(archive, 0);
	357	for (i = 0; i < num_files; i++) {
	358	entry_name = zip_get_name(archive, i, 0);
	359	if (!entry_name \|\| strncmp(entry_name, basename, baselen) != 0) {
	360	continue;
	361	} else if (entry_name[baselen] == '-') {
	362	chunk_num = g_ascii_strtoull(entry_name + baselen + 1, NULL, 10);
	363	if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
	364	next_chunk_num = chunk_num + 1;
	365	}
	366	}
	367
	368	chunksize = sizeof(float) * analog->num_samples;
	369	if (!(chunkbuf = g_try_malloc(chunksize)))
	370	return SR_ERR;
	371	if (sr_analog_to_float(analog, chunkbuf) != SR_OK)
	372	return SR_ERR;
	373
	374	analogsrc = zip_source_buffer(archive, chunkbuf, chunksize, FALSE);
	375	chunkname = g_strdup_printf("%s-%u", basename, next_chunk_num);
	376	i = zip_add(archive, chunkname, analogsrc);
	377	g_free(chunkname);
	378	if (i < 0) {
	379	sr_err("Failed to add chunk '%s': %s", chunkname, zip_strerror(archive));
	380	zip_source_free(analogsrc);
	381	zip_discard(archive);
	382	return SR_ERR;
	383	}
	384	if (zip_close(archive) < 0) {
	385	sr_err("Error saving session file: %s", zip_strerror(archive));
	386	zip_discard(archive);
	387	return SR_ERR;
	388	}
	389
	390	return SR_OK;
	391	}
	392
3250d8c7 BV	393	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
	394	GString **out)
	395	{
	396	struct out_context *outc;
	397	const struct sr_datafeed_meta *meta;
	398	const struct sr_datafeed_logic *logic;
7163dcbe	399	const struct sr_datafeed_analog *analog;
3250d8c7 BV	400	const struct sr_config *src;
	401	GSList *l;
	402
	403	int ret;
	404
	405	*out = NULL;
	406	if (!o \|\| !o->sdi \|\| !(outc = o->priv))
	407	return SR_ERR_ARG;
	408
	409	switch (packet->type) {
	410	case SR_DF_META:
	411	meta = packet->payload;
	412	for (l = meta->config; l; l = l->next) {
	413	src = l->data;
	414	if (src->key != SR_CONF_SAMPLERATE)
	415	continue;
	416	outc->samplerate = g_variant_get_uint64(src->data);
	417	}
	418	break;
	419	case SR_DF_LOGIC:
	420	if (!outc->zip_created) {
	421	if ((ret = zip_create(o)) != SR_OK)
	422	return ret;
	423	outc->zip_created = TRUE;
	424	}
	425	logic = packet->payload;
	426	ret = zip_append(o, logic->data, logic->unitsize, logic->length);
e57057ae UH	427	if (ret != SR_OK)
e57057ae UH	428	return ret;
3250d8c7	429	break;
7163dcbe ML	430	case SR_DF_ANALOG:
	431	if (!outc->zip_created) {
	432	if ((ret = zip_create(o)) != SR_OK)
	433	return ret;
	434	outc->zip_created = TRUE;
	435	}
	436	analog = packet->payload;
	437	ret = zip_append_analog(o, analog);
	438	if (ret != SR_OK)
	439	return ret;
	440	break;
3250d8c7 BV	441	}
	442
	443	return SR_OK;
	444	}
	445
3250d8c7	446	static struct sr_option options[] = {
3250d8c7 BV	447	ALL_ZERO
	448	};
	449
	450	static const struct sr_option *get_options(void)
	451	{
	452	if (!options[0].def)
	453	options[0].def = g_variant_ref_sink(g_variant_new_string(""));
	454
	455	return options;
	456	}
	457
da3d141f SB	458	static int cleanup(struct sr_output *o)
	459	{
	460	struct out_context *outc;
	461
	462	outc = o->priv;
	463	g_variant_unref(options[0].def);
0586a0ef	464	g_free(outc->analog_index_map);
da3d141f SB	465	g_free(outc->filename);
	466	g_free(outc);
	467	o->priv = NULL;
	468
	469	return SR_OK;
	470	}
	471
3250d8c7 BV	472	SR_PRIV struct sr_output_module output_srzip = {
	473	.id = "srzip",
	474	.name = "srzip",
	475	.desc = "srzip session file",
8a174d23	476	.exts = (const char*[]){"sr", NULL},
3cd4b381	477	.flags = SR_OUTPUT_INTERNAL_IO_HANDLING,
3250d8c7 BV	478	.options = get_options,
	479	.init = init,
	480	.receive = receive,
	481	.cleanup = cleanup,
	482	};