[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;
};

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;

	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";
	g_key_file_set_string(meta, devgroup, "capturefile", "logic-1");

	g_key_file_set_integer(meta, devgroup, "total probes",
			g_slist_length(o->sdi->channels));

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

	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;
		if (ch->enabled && ch->type == SR_CHANNEL_LOGIC) {
			s = g_strdup_printf("probe%d", ch->index + 1);
			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 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_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;
	}

	return SR_OK;
}

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

	outc = o->priv;
	g_free(outc->filename);
	g_free(outc);
	o->priv = NULL;

	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;
}

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;
	36	};
	37
	38	static int init(struct sr_output o, GHashTable options)
	39	{
	40	struct out_context *outc;
	41
37875f75 SA	42	(void)options;
37875f75 SA	43
98654c99	44	if (!o->filename \|\| o->filename[0] == '\0') {
37875f75	45	sr_info("srzip output module requires a file name, cannot save.");
3250d8c7	46	return SR_ERR_ARG;
37875f75	47	}
7df31ae8 SA	48
7df31ae8 SA	49	outc = g_malloc0(sizeof(struct out_context));
37875f75	50	outc->filename = g_strdup(o->filename);
7df31ae8	51	o->priv = outc;
3250d8c7 BV	52
	53	return SR_OK;
	54	}
	55
	56	static int zip_create(const struct sr_output *o)
	57	{
	58	struct out_context *outc;
3250d8c7 BV	59	struct zip *zipfile;
3250d8c7 BV	60	struct zip_source versrc, metasrc;
98654c99	61	struct sr_channel *ch;
3250d8c7	62	GVariant *gvar;
98654c99	63	GKeyFile *meta;
3250d8c7	64	GSList *l;
98654c99 DE	65	const char *devgroup;
	66	char s, metabuf;
	67	gsize metalen;
3250d8c7 BV	68
3250d8c7 BV	69	outc = o->priv;
98654c99 DE	70
	71	if (outc->samplerate == 0 && sr_config_get(o->sdi->driver, o->sdi, NULL,
	72	SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
	73	outc->samplerate = g_variant_get_uint64(gvar);
	74	g_variant_unref(gvar);
3250d8c7 BV	75	}
	76
	77	/* Quietly delete it first, libzip wants replace ops otherwise. */
98654c99 DE	78	g_unlink(outc->filename);
	79	zipfile = zip_open(outc->filename, ZIP_CREATE, NULL);
	80	if (!zipfile)
3250d8c7 BV	81	return SR_ERR;
	82
	83	/* "version" */
98654c99	84	versrc = zip_source_buffer(zipfile, "2", 1, FALSE);
eaa6a7a3	85	if (zip_add(zipfile, "version", versrc) < 0) {
98654c99	86	sr_err("Error saving version into zipfile: %s",
3250d8c7	87	zip_strerror(zipfile));
98654c99 DE	88	zip_source_free(versrc);
98654c99 DE	89	zip_discard(zipfile);
3250d8c7 BV	90	return SR_ERR;
	91	}
	92
	93	/* init "metadata" */
98654c99 DE	94	meta = g_key_file_new();
	95
	96	g_key_file_set_string(meta, "global", "sigrok version",
	97	SR_PACKAGE_VERSION_STRING);
	98
	99	devgroup = "device 1";
	100	g_key_file_set_string(meta, devgroup, "capturefile", "logic-1");
	101
	102	g_key_file_set_integer(meta, devgroup, "total probes",
	103	g_slist_length(o->sdi->channels));
	104
3250d8c7	105	s = sr_samplerate_string(outc->samplerate);
98654c99	106	g_key_file_set_string(meta, devgroup, "samplerate", s);
3250d8c7 BV	107	g_free(s);
	108
	109	for (l = o->sdi->channels; l; l = l->next) {
	110	ch = l->data;
98654c99 DE	111	if (ch->enabled && ch->type == SR_CHANNEL_LOGIC) {
	112	s = g_strdup_printf("probe%d", ch->index + 1);
	113	g_key_file_set_string(meta, devgroup, s, ch->name);
	114	g_free(s);
	115	}
3250d8c7	116	}
98654c99 DE	117	metabuf = g_key_file_to_data(meta, &metalen, NULL);
98654c99 DE	118	g_key_file_free(meta);
3250d8c7	119
98654c99	120	metasrc = zip_source_buffer(zipfile, metabuf, metalen, FALSE);
eaa6a7a3	121	if (zip_add(zipfile, "metadata", metasrc) < 0) {
98654c99 DE	122	sr_err("Error saving metadata into zipfile: %s",
	123	zip_strerror(zipfile));
	124	zip_source_free(metasrc);
	125	zip_discard(zipfile);
	126	g_free(metabuf);
3250d8c7 BV	127	return SR_ERR;
	128	}
	129
98654c99 DE	130	if (zip_close(zipfile) < 0) {
	131	sr_err("Error saving zipfile: %s", zip_strerror(zipfile));
	132	zip_discard(zipfile);
	133	g_free(metabuf);
3250d8c7 BV	134	return SR_ERR;
3250d8c7 BV	135	}
98654c99	136	g_free(metabuf);
3250d8c7 BV	137
	138	return SR_OK;
	139	}
	140
	141	static int zip_append(const struct sr_output o, unsigned char buf,
	142	int unitsize, int length)
	143	{
	144	struct out_context *outc;
	145	struct zip *archive;
	146	struct zip_source *logicsrc;
98654c99	147	int64_t i, num_files;
3250d8c7 BV	148	struct zip_stat zs;
	149	struct zip_source *metasrc;
	150	GKeyFile *kf;
	151	GError *error;
98654c99	152	uint64_t chunk_num;
3250d8c7	153	const char *entry_name;
98654c99 DE	154	char *metabuf;
	155	gsize metalen;
	156	char *chunkname;
	157	unsigned int next_chunk_num;
3250d8c7 BV	158
3250d8c7 BV	159	outc = o->priv;
98654c99	160	if (!(archive = zip_open(outc->filename, 0, NULL)))
3250d8c7 BV	161	return SR_ERR;
3250d8c7 BV	162
98654c99 DE	163	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
	164	sr_err("Failed to open metadata: %s", zip_strerror(archive));
	165	zip_discard(archive);
3250d8c7	166	return SR_ERR;
98654c99 DE	167	}
	168	kf = sr_sessionfile_read_metadata(archive, &zs);
	169	if (!kf) {
	170	zip_discard(archive);
	171	return SR_ERR_DATA;
	172	}
3250d8c7 BV	173	/*
	174	* If the file was only initialized but doesn't yet have any
	175	* data it in, it won't have a unitsize field in metadata yet.
	176	*/
	177	error = NULL;
98654c99	178	metabuf = NULL;
3250d8c7 BV	179	if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
3250d8c7 BV	180	if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
98654c99 DE	181	sr_err("Failed to check unitsize key: %s", error->message);
	182	g_error_free(error);
	183	g_key_file_free(kf);
	184	zip_discard(archive);
3250d8c7 BV	185	return SR_ERR;
3250d8c7 BV	186	}
98654c99 DE	187	g_clear_error(&error);
98654c99 DE	188
3250d8c7 BV	189	/* Add unitsize field. */
3250d8c7 BV	190	g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
98654c99 DE	191	metabuf = g_key_file_to_data(kf, &metalen, NULL);
	192	metasrc = zip_source_buffer(archive, metabuf, metalen, FALSE);
	193
	194	if (zip_replace(archive, zs.index, metasrc) < 0) {
	195	sr_err("Failed to replace metadata: %s",
	196	zip_strerror(archive));
	197	g_key_file_free(kf);
	198	zip_source_free(metasrc);
	199	zip_discard(archive);
	200	g_free(metabuf);
3250d8c7 BV	201	return SR_ERR;
3250d8c7 BV	202	}
3250d8c7 BV	203	}
	204	g_key_file_free(kf);
	205
	206	next_chunk_num = 1;
	207	num_files = zip_get_num_entries(archive, 0);
	208	for (i = 0; i < num_files; i++) {
	209	entry_name = zip_get_name(archive, i, 0);
98654c99	210	if (!entry_name \|\| strncmp(entry_name, "logic-1", 7) != 0)
3250d8c7	211	continue;
98654c99	212	if (entry_name[7] == '\0') {
3250d8c7 BV	213	/* This file has no extra chunks, just a single "logic-1".
3250d8c7 BV	214	* Rename it to "logic-1-1" * and continue with chunk 2. */
98654c99 DE	215	if (zip_rename(archive, i, "logic-1-1") < 0) {
	216	sr_err("Failed to rename 'logic-1' to 'logic-1-1': %s",
	217	zip_strerror(archive));
	218	zip_discard(archive);
	219	g_free(metabuf);
3250d8c7 BV	220	return SR_ERR;
	221	}
	222	next_chunk_num = 2;
	223	break;
98654c99 DE	224	} else if (entry_name[7] == '-') {
	225	chunk_num = g_ascii_strtoull(entry_name + 8, NULL, 10);
	226	if (chunk_num < G_MAXINT && chunk_num >= next_chunk_num)
3250d8c7 BV	227	next_chunk_num = chunk_num + 1;
	228	}
	229	}
98654c99 DE	230
	231	if (length % unitsize != 0) {
	232	sr_warn("Chunk size %d not a multiple of the"
	233	" unit size %d.", length, unitsize);
3250d8c7	234	}
98654c99 DE	235	logicsrc = zip_source_buffer(archive, buf, length, FALSE);
	236	chunkname = g_strdup_printf("logic-1-%u", next_chunk_num);
	237	i = zip_add(archive, chunkname, logicsrc);
	238	g_free(chunkname);
	239	if (i < 0) {
	240	sr_err("Failed to add chunk 'logic-1-%u': %s",
	241	next_chunk_num, zip_strerror(archive));
	242	zip_source_free(logicsrc);
	243	zip_discard(archive);
	244	g_free(metabuf);
3250d8c7 BV	245	return SR_ERR;
3250d8c7 BV	246	}
98654c99 DE	247	if (zip_close(archive) < 0) {
	248	sr_err("Error saving session file: %s", zip_strerror(archive));
	249	zip_discard(archive);
	250	g_free(metabuf);
3250d8c7 BV	251	return SR_ERR;
3250d8c7 BV	252	}
98654c99	253	g_free(metabuf);
3250d8c7 BV	254
	255	return SR_OK;
	256	}
	257
	258	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
	259	GString **out)
	260	{
	261	struct out_context *outc;
	262	const struct sr_datafeed_meta *meta;
	263	const struct sr_datafeed_logic *logic;
	264	const struct sr_config *src;
	265	GSList *l;
	266
	267	int ret;
	268
	269	*out = NULL;
	270	if (!o \|\| !o->sdi \|\| !(outc = o->priv))
	271	return SR_ERR_ARG;
	272
	273	switch (packet->type) {
	274	case SR_DF_META:
	275	meta = packet->payload;
	276	for (l = meta->config; l; l = l->next) {
	277	src = l->data;
	278	if (src->key != SR_CONF_SAMPLERATE)
	279	continue;
	280	outc->samplerate = g_variant_get_uint64(src->data);
	281	}
	282	break;
	283	case SR_DF_LOGIC:
	284	if (!outc->zip_created) {
	285	if ((ret = zip_create(o)) != SR_OK)
	286	return ret;
	287	outc->zip_created = TRUE;
	288	}
	289	logic = packet->payload;
	290	ret = zip_append(o, logic->data, logic->unitsize, logic->length);
e57057ae UH	291	if (ret != SR_OK)
e57057ae UH	292	return ret;
3250d8c7 BV	293	break;
	294	}
	295
	296	return SR_OK;
	297	}
	298
	299	static int cleanup(struct sr_output *o)
	300	{
	301	struct out_context *outc;
	302
	303	outc = o->priv;
	304	g_free(outc->filename);
	305	g_free(outc);
	306	o->priv = NULL;
	307
	308	return SR_OK;
	309	}
	310
	311	static struct sr_option options[] = {
3250d8c7 BV	312	ALL_ZERO
	313	};
	314
	315	static const struct sr_option *get_options(void)
	316	{
	317	if (!options[0].def)
	318	options[0].def = g_variant_ref_sink(g_variant_new_string(""));
	319
	320	return options;
	321	}
	322
	323	SR_PRIV struct sr_output_module output_srzip = {
	324	.id = "srzip",
	325	.name = "srzip",
	326	.desc = "srzip session file",
8a174d23	327	.exts = (const char*[]){"sr", NULL},
3cd4b381	328	.flags = SR_OUTPUT_INTERNAL_IO_HANDLING,
3250d8c7 BV	329	.options = get_options,
	330	.init = init,
	331	.receive = receive,
	332	.cleanup = cleanup,
	333	};