X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Foutput%2Fsrzip.c;h=43dbd16b0a05da2f852ada1d4c9d57d46dc4ddce;hb=815685462fdab21a390b5aecc253b92753439f06;hp=84755a3d56c42429c6dc9a97fe081f50e7b3d750;hpb=1beccaed464a4d92a070988a0331fe399f9f7a7a;p=libsigrok.git

diff --git a/src/output/srzip.c b/src/output/srzip.c
index 84755a3d..43dbd16b 100644
--- a/src/output/srzip.c
+++ b/src/output/srzip.c
@@ -17,14 +17,14 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <stdlib.h>
-#include <unistd.h>
 #include <string.h>
 #include <errno.h>
 #include <glib.h>
 #include <glib/gstdio.h>
 #include <zip.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "output/srzip"
@@ -33,17 +33,24 @@ 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;
-	outc->filename = g_strdup(g_variant_get_string(g_hash_table_lookup(options, "filename"), NULL));
-	if (strlen(outc->filename) == 0)
-		return SR_ERR_ARG;
 
 	return SR_OK;
 }
@@ -51,79 +58,132 @@ static int init(struct sr_output *o, GHashTable *options)
 static int zip_create(const struct sr_output *o)
 {
 	struct out_context *outc;
-	struct sr_channel *ch;
-	FILE *meta;
 	struct zip *zipfile;
 	struct zip_source *versrc, *metasrc;
+	struct sr_channel *ch;
 	GVariant *gvar;
+	GKeyFile *meta;
 	GSList *l;
-	int tmpfile, ret;
-	char version[1], metafile[32], *s;
+	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) {
-		if (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);
-		}
+
+	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. */
-	unlink(outc->filename);
-	if (!(zipfile = zip_open(outc->filename, ZIP_CREATE, &ret)))
+	g_unlink(outc->filename);
+	zipfile = zip_open(outc->filename, ZIP_CREATE, NULL);
+	if (!zipfile)
 		return SR_ERR;
 
 	/* "version" */
-	version[0] = '2';
-	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
-		return SR_ERR;
-	if (zip_add(zipfile, "version", versrc) == -1) {
-		sr_info("Error saving version into zipfile: %s.",
+	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" */
-	strcpy(metafile, "sigrok-meta-XXXXXX");
-	if ((tmpfile = g_mkstemp(metafile)) == -1)
-		return SR_ERR;
-	close(tmpfile);
-	meta = g_fopen(metafile, "wb");
-	fprintf(meta, "[global]\n");
-	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
-	fprintf(meta, "[device 1]\ncapturefile = logic-1\n");
-	fprintf(meta, "total probes = %d\n", g_slist_length(o->sdi->channels));
+	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);
-	fprintf(meta, "samplerate = %s\n", s);
+	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
+	 * entry as terminator, which is set to -1. */
+	outc->analog_index_map = g_malloc0(sizeof(gint) * (enabled_analog_channels + 1));
+	outc->analog_index_map[enabled_analog_channels] = -1;
+
+	index = 0;
 	for (l = o->sdi->channels; l; l = l->next) {
 		ch = l->data;
-		if (ch->type != SR_CHANNEL_LOGIC)
-			continue;
 		if (!ch->enabled)
 			continue;
-		fprintf(meta, "probe%d = %s\n", ch->index + 1, ch->name);
-	}
-	fclose(meta);
 
-	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
-		unlink(metafile);
-		return SR_ERR;
+		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);
 	}
-	if (zip_add(zipfile, "metadata", metasrc) == -1) {
-		unlink(metafile);
+
+	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 ((ret = zip_close(zipfile)) == -1) {
-		sr_info("Error saving zipfile: %s.", zip_strerror(zipfile));
-		unlink(metafile);
+	if (zip_close(zipfile) < 0) {
+		sr_err("Error saving zipfile: %s", zip_strerror(zipfile));
+		zip_discard(zipfile);
+		g_free(metabuf);
 		return SR_ERR;
 	}
-
-	unlink(metafile);
+	g_free(metabuf);
 
 	return SR_OK;
 }
@@ -134,72 +194,62 @@ static int zip_append(const struct sr_output *o, unsigned char *buf,
 	struct out_context *outc;
 	struct zip *archive;
 	struct zip_source *logicsrc;
-	zip_int64_t num_files;
-	struct zip_file *zf;
+	int64_t i, num_files;
 	struct zip_stat zs;
 	struct zip_source *metasrc;
 	GKeyFile *kf;
 	GError *error;
-	gsize len;
-	int chunk_num, next_chunk_num, tmpfile, ret, i;
+	uint64_t chunk_num;
 	const char *entry_name;
-	char *metafile, tmpname[32], chunkname[16];
+	char *metabuf;
+	gsize metalen;
+	char *chunkname;
+	unsigned int next_chunk_num;
 
 	outc = o->priv;
-	if (!(archive = zip_open(outc->filename, 0, &ret)))
+	if (!(archive = zip_open(outc->filename, 0, NULL)))
 		return SR_ERR;
 
-	if (zip_stat(archive, "metadata", 0, &zs) == -1)
+	if (zip_stat(archive, "metadata", 0, &zs) < 0) {
+		sr_err("Failed to open metadata: %s", zip_strerror(archive));
+		zip_discard(archive);
 		return SR_ERR;
-
-	metafile = g_malloc(zs.size);
-	zf = zip_fopen_index(archive, zs.index, 0);
-	zip_fread(zf, metafile, zs.size);
-	zip_fclose(zf);
-
+	}
+	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;
-	kf = g_key_file_new();
-	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
-		sr_err("Failed to parse metadata: %s.", error->message);
-		return SR_ERR;
-	}
-	g_free(metafile);
-	tmpname[0] = '\0';
+	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 ? error->message : "?");
+			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);
-		metafile = g_key_file_to_data(kf, &len, &error);
-		strcpy(tmpname, "sigrok-meta-XXXXXX");
-		if ((tmpfile = g_mkstemp(tmpname)) == -1)
-			return SR_ERR;
-		if (write(tmpfile, metafile, len) < 0) {
-			sr_dbg("Failed to create new metadata: %s", strerror(errno));
-			g_free(metafile);
-			unlink(tmpname);
-			return SR_ERR;
-		}
-		close(tmpfile);
-		if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
-			sr_err("Failed to create zip source for metadata.");
-			g_free(metafile);
-			unlink(tmpname);
+		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;
 		}
-		if (zip_replace(archive, zs.index, metasrc) == -1) {
-			sr_err("Failed to replace metadata file.");
-			g_free(metafile);
-			unlink(tmpname);
-			return SR_ERR;
-		}
-		g_free(metafile);
 	}
 	g_key_file_free(kf);
 
@@ -207,41 +257,149 @@ static int zip_append(const struct sr_output *o, unsigned char *buf,
 	num_files = zip_get_num_entries(archive, 0);
 	for (i = 0; i < num_files; i++) {
 		entry_name = zip_get_name(archive, i, 0);
-		if (strncmp(entry_name, "logic-1", 7))
+		if (!entry_name || strncmp(entry_name, "logic-1", 7) != 0)
 			continue;
-		if (strlen(entry_name) == 7) {
+		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") == -1) {
-				sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
-				unlink(tmpname);
+			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 (strlen(entry_name) > 8 && entry_name[7] == '-') {
-			chunk_num = strtoull(entry_name + 8, NULL, 10);
-			if (chunk_num >= next_chunk_num)
+		} 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;
 		}
 	}
-	snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
-	if (!(logicsrc = zip_source_buffer(archive, buf, length, FALSE))) {
-		unlink(tmpname);
+
+	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_add(archive, chunkname, logicsrc) == -1) {
-		unlink(tmpname);
+	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;
+
+	/* 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;
 	}
-	if ((ret = zip_close(archive)) == -1) {
-		sr_info("error saving session file: %s", zip_strerror(archive));
-		unlink(tmpname);
+	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] != -1; index++)
+		if (outc->analog_index_map[index] == channel->index)
+			break;
+	if (outc->analog_index_map[index] == -1)
+		return SR_ERR_ARG; /* Channel index was not in the list */
+
+	index += outc->first_analog_index;
+
+	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));
+		goto err_zip_discard;
 	}
-	unlink(tmpname);
+
+	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)))
+		goto err_free_basename;
+
+	if (sr_analog_to_float(analog, chunkbuf) != SR_OK)
+		goto err_free_chunkbuf;
+
+	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);
+		goto err_free_chunkbuf;
+	}
+	if (zip_close(archive) < 0) {
+		sr_err("Error saving session file: %s", zip_strerror(archive));
+		goto err_free_chunkbuf;
+	}
+
+	g_free(basename);
+	g_free(chunkbuf);
 
 	return SR_OK;
+
+err_free_chunkbuf:
+	g_free(chunkbuf);
+err_free_basename:
+	g_free(basename);
+err_zip_discard:
+	zip_discard(archive);
+
+	return SR_ERR;
 }
 
 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
@@ -250,6 +408,7 @@ static int receive(const struct sr_output *o, const struct sr_datafeed_packet *p
 	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;
 
@@ -277,26 +436,26 @@ static int receive(const struct sr_output *o, const struct sr_datafeed_packet *p
 		}
 		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 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[] = {
-	{ "filename", "Filename", "File to write", NULL, NULL },
 	ALL_ZERO
 };
 
@@ -308,11 +467,26 @@ static const struct sr_option *get_options(void)
 	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,