[libsigrok.git] / session_file.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 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 <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <zip.h>
#include <glib.h>
#include <glib/gstdio.h>
#include "config.h" /* Needed for PACKAGE_VERSION and others. */
#include "libsigrok.h"
#include "libsigrok-internal.h"

/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "session-file: "
#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)

/**
 * @file
 *
 * Loading and saving libsigrok session files.
 */

/**
 * @addtogroup grp_session
 *
 * @{
 */

extern struct sr_session *session;
extern SR_PRIV struct sr_dev_driver session_driver;

/** @private */
SR_PRIV int sr_sessionfile_check(const char *filename)
{
	struct zip *archive;
	struct zip_file *zf;
	struct zip_stat zs;
	int version, ret;
	char s[11];

	if (!filename)
		return SR_ERR_ARG;

	if (!(archive = zip_open(filename, 0, &ret)))
		/* No logging: this can be used just to check if it's
		 * a sigrok session file or not. */
		return SR_ERR;

	/* check "version" */
	version = 0;
	if (!(zf = zip_fopen(archive, "version", 0))) {
		sr_dbg("Not a sigrok session file: no version found.");
		return SR_ERR;
	}
	if ((ret = zip_fread(zf, s, 10)) == -1)
		return SR_ERR;
	zip_fclose(zf);
	s[ret] = 0;
	version = strtoull(s, NULL, 10);
	if (version != 1) {
		sr_dbg("Cannot handle sigrok session file version %d.", version);
		return SR_ERR;
	}

	/* read "metadata" */
	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
		sr_dbg("Not a valid sigrok session file.");
		return SR_ERR;
	}

	return SR_OK;
}

/**
 * Load the session from the specified filename.
 *
 * @param filename The name of the session file to load. Must not be NULL.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
 *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
 *         other errors.
 */
SR_API int sr_session_load(const char *filename)
{
	GKeyFile *kf;
	GPtrArray *capturefiles;
	struct zip *archive;
	struct zip_file *zf;
	struct zip_stat zs;
	struct sr_dev_inst *sdi;
	struct sr_probe *probe;
	int ret, probenum, devcnt, i, j;
	uint64_t tmp_u64, total_probes, enabled_probes, p;
	char **sections, **keys, *metafile, *val;
	char probename[SR_MAX_PROBENAME_LEN + 1];

	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
		return ret;

	if (!(archive = zip_open(filename, 0, &ret)))
		return SR_ERR;

	if (zip_stat(archive, "metadata", 0, &zs) == -1)
		return SR_ERR;

	if (!(metafile = g_try_malloc(zs.size))) {
		sr_err("%s: metafile malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

	zf = zip_fopen_index(archive, zs.index, 0);
	zip_fread(zf, metafile, zs.size);
	zip_fclose(zf);

	kf = g_key_file_new();
	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
		sr_dbg("Failed to parse metadata.");
		return SR_ERR;
	}

	sr_session_new();

	devcnt = 0;
	capturefiles = g_ptr_array_new_with_free_func(g_free);
	sections = g_key_file_get_groups(kf, NULL);
	for (i = 0; sections[i]; i++) {
		if (!strcmp(sections[i], "global"))
			/* nothing really interesting in here yet */
			continue;
		if (!strncmp(sections[i], "device ", 7)) {
			/* device section */
			sdi = NULL;
			enabled_probes = total_probes = 0;
			keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
			for (j = 0; keys[j]; j++) {
				val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
				if (!strcmp(keys[j], "capturefile")) {
					sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
					sdi->driver = &session_driver;
					if (devcnt == 0)
						/* first device, init the driver */
						sdi->driver->init(NULL);
					sr_dev_open(sdi);
					sr_session_dev_add(sdi);
					sdi->driver->config_set(SR_CONF_SESSIONFILE,
							g_variant_new_string(filename), sdi, NULL);
					sdi->driver->config_set(SR_CONF_CAPTUREFILE,
							g_variant_new_string(val), sdi, NULL);
					g_ptr_array_add(capturefiles, val);
				} else if (!strcmp(keys[j], "samplerate")) {
					sr_parse_sizestring(val, &tmp_u64);
					sdi->driver->config_set(SR_CONF_SAMPLERATE,
							g_variant_new_uint64(tmp_u64), sdi, NULL);
				} else if (!strcmp(keys[j], "unitsize")) {
					tmp_u64 = strtoull(val, NULL, 10);
					sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
							g_variant_new_uint64(tmp_u64), sdi, NULL);
				} else if (!strcmp(keys[j], "total probes")) {
					total_probes = strtoull(val, NULL, 10);
					sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
							g_variant_new_uint64(total_probes), sdi, NULL);
					for (p = 0; p < total_probes; p++) {
						snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
						if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
								probename)))
							return SR_ERR;
						sdi->probes = g_slist_append(sdi->probes, probe);
					}
				} else if (!strncmp(keys[j], "probe", 5)) {
					if (!sdi)
						continue;
					enabled_probes++;
					tmp_u64 = strtoul(keys[j]+5, NULL, 10);
					/* sr_session_save() */
					sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
				} else if (!strncmp(keys[j], "trigger", 7)) {
					probenum = strtoul(keys[j]+7, NULL, 10);
					sr_dev_trigger_set(sdi, probenum, val);
				}
			}
			g_strfreev(keys);
			/* Disable probes not specifically listed. */
			if (total_probes)
				for (p = enabled_probes; p < total_probes; p++)
					sr_dev_probe_enable(sdi, p, FALSE);
		}
		devcnt++;
	}
	g_strfreev(sections);
	g_key_file_free(kf);

	return SR_OK;
}

/**
 * Save the current session to the specified file.
 *
 * @param filename The name of the filename to save the current session as.
 *                 Must not be NULL.
 * @param sdi The device instance from which the data was captured.
 * @param buf The data to be saved.
 * @param unitsize The number of bytes per sample.
 * @param units The number of samples.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
 *         upon other errors.
 */
SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
		unsigned char *buf, int unitsize, int units)
{
	GSList *l;
	GVariant *gvar;
	FILE *meta;
	struct sr_probe *probe;
	struct zip *zipfile;
	struct zip_source *versrc, *metasrc, *logicsrc;
	int tmpfile, ret, probecnt;
	uint64_t samplerate;
	char version[1], rawname[16], metafile[32], *s;

	if (!filename) {
		sr_err("%s: filename was NULL", __func__);
		return SR_ERR_ARG;
	}

	/* Quietly delete it first, libzip wants replace ops otherwise. */
	unlink(filename);
	if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
		return SR_ERR;

	/* "version" */
	version[0] = '1';
	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",
			zip_strerror(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);

	/* metadata */
	fprintf(meta, "[device 1]\n");
	if (sdi->driver)
		fprintf(meta, "driver = %s\n", sdi->driver->name);

	/* metadata */
	fprintf(meta, "capturefile = logic-1\n");
	fprintf(meta, "unitsize = %d\n", unitsize);
	fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
	if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
		if (sr_config_get(sdi->driver, sdi, NULL,
					SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
			samplerate = g_variant_get_uint64(gvar);
			s = sr_samplerate_string(samplerate);
			fprintf(meta, "samplerate = %s\n", s);
			g_free(s);
			g_variant_unref(gvar);
		}
	}
	probecnt = 1;
	for (l = sdi->probes; l; l = l->next) {
		probe = l->data;
		if (probe->enabled) {
			if (probe->name)
				fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
			if (probe->trigger)
				fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
			probecnt++;
		}
	}

	if (!(logicsrc = zip_source_buffer(zipfile, buf,
			   units * unitsize, FALSE)))
		return SR_ERR;
	snprintf(rawname, 15, "logic-1");
	if (zip_add(zipfile, rawname, logicsrc) == -1)
		return SR_ERR;
	fclose(meta);

	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
		return SR_ERR;
	if (zip_add(zipfile, "metadata", metasrc) == -1)
		return SR_ERR;

	if ((ret = zip_close(zipfile)) == -1) {
		sr_info("error saving zipfile: %s", zip_strerror(zipfile));
		return SR_ERR;
	}

	unlink(metafile);

	return SR_OK;
}

/**
 * Append data to an existing session file.
 *
 * @param filename The name of the filename to append to. Must not be NULL.
 * @param buf The data to be appended.
 * @param unitsize The number of bytes per sample.
 * @param units The number of samples.
 *
 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
 *         upon other errors.
 */
SR_API int sr_session_append(const char *filename, unsigned char *buf,
		int unitsize, int units)
{
	struct zip *archive;
	struct zip_source *logicsrc;
	zip_int64_t num_files;
	int chunk_num, next_chunk_num, ret, i;
	const char *entry_name;
	char chunkname[16];

	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
		return ret;

	if (!(archive = zip_open(filename, 0, &ret)))
		return SR_ERR;

	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 (strncmp(entry_name, "logic-1", 7))
			continue;
		if (strlen(entry_name) == 7) {
			/* 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'.");
				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)
				next_chunk_num = chunk_num + 1;
		}
	}
	snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
	if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE)))
		return SR_ERR;
	if (zip_add(archive, chunkname, logicsrc) == -1)
		return SR_ERR;
	if ((ret = zip_close(archive)) == -1) {
		sr_info("error saving session file: %s", zip_strerror(archive));
		return SR_ERR;
	}

	return SR_OK;
}

/** @} */
Commit	Line	Data
7d658874	1	/*
50985c20	2	* This file is part of the libsigrok project.
7d658874	3	*
13d8e03c	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7d658874 BV	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
	20	#include <string.h>
	21	#include <stdlib.h>
	22	#include <unistd.h>
	23	#include <zip.h>
	24	#include <glib.h>
3bbd9849	25	#include <glib/gstdio.h>
545f9786	26	#include "config.h" /* Needed for PACKAGE_VERSION and others. */
45c59c8b BV	27	#include "libsigrok.h"
45c59c8b BV	28	#include "libsigrok-internal.h"
7d658874	29
29a27196 UH	30	/* Message logging helpers with subsystem-specific prefix string. */
	31	#define LOG_PREFIX "session-file: "
	32	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	33	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	34	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	35	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	36	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	37	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
a885ce3e	38
393fb9cb UH	39	/**
	40	* @file
	41	*
	42	* Loading and saving libsigrok session files.
	43	*/
	44
7b870c38	45	/**
777e2035	46	* @addtogroup grp_session
7b870c38 UH	47	*
	48	* @{
	49	*/
	50
2872d21e	51	extern struct sr_session *session;
c09f0b57	52	extern SR_PRIV struct sr_dev_driver session_driver;
7d658874	53
72a08bcc	54	/** @private */
f438e0c9	55	SR_PRIV int sr_sessionfile_check(const char *filename)
7d658874	56	{
7d658874 BV	57	struct zip *archive;
	58	struct zip_file *zf;
	59	struct zip_stat zs;
f438e0c9 BV	60	int version, ret;
f438e0c9 BV	61	char s[11];
7d658874	62
f438e0c9	63	if (!filename)
9f45fb3a	64	return SR_ERR_ARG;
9f45fb3a	65
f438e0c9 BV	66	if (!(archive = zip_open(filename, 0, &ret)))
	67	/* No logging: this can be used just to check if it's
	68	* a sigrok session file or not. */
7d658874	69	return SR_ERR;
7d658874 BV	70
7d658874 BV	71	/* check "version" */
c1864d55	72	version = 0;
7d658874	73	if (!(zf = zip_fopen(archive, "version", 0))) {
f438e0c9	74	sr_dbg("Not a sigrok session file: no version found.");
7d658874 BV	75	return SR_ERR;
7d658874 BV	76	}
f438e0c9	77	if ((ret = zip_fread(zf, s, 10)) == -1)
7d658874	78	return SR_ERR;
7d658874	79	zip_fclose(zf);
c1864d55 BV	80	s[ret] = 0;
	81	version = strtoull(s, NULL, 10);
	82	if (version != 1) {
f438e0c9	83	sr_dbg("Cannot handle sigrok session file version %d.", version);
c1864d55 BV	84	return SR_ERR;
c1864d55 BV	85	}
7d658874 BV	86
	87	/* read "metadata" */
	88	if (zip_stat(archive, "metadata", 0, &zs) == -1) {
a885ce3e	89	sr_dbg("Not a valid sigrok session file.");
7d658874 BV	90	return SR_ERR;
7d658874 BV	91	}
b53738ba	92
f438e0c9 BV	93	return SR_OK;
	94	}
	95
	96	/**
	97	* Load the session from the specified filename.
	98	*
	99	* @param filename The name of the session file to load. Must not be NULL.
	100	*
	101	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
	102	* SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
	103	* other errors.
	104	*/
	105	SR_API int sr_session_load(const char *filename)
	106	{
	107	GKeyFile *kf;
	108	GPtrArray *capturefiles;
	109	struct zip *archive;
	110	struct zip_file *zf;
	111	struct zip_stat zs;
	112	struct sr_dev_inst *sdi;
	113	struct sr_probe *probe;
	114	int ret, probenum, devcnt, i, j;
	115	uint64_t tmp_u64, total_probes, enabled_probes, p;
	116	char sections, keys, metafile, val;
	117	char probename[SR_MAX_PROBENAME_LEN + 1];
	118
	119	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
	120	return ret;
	121
	122	if (!(archive = zip_open(filename, 0, &ret)))
	123	return SR_ERR;
	124
	125	if (zip_stat(archive, "metadata", 0, &zs) == -1)
	126	return SR_ERR;
	127
b53738ba	128	if (!(metafile = g_try_malloc(zs.size))) {
a885ce3e	129	sr_err("%s: metafile malloc failed", __func__);
b53738ba UH	130	return SR_ERR_MALLOC;
	131	}
	132
7d658874 BV	133	zf = zip_fopen_index(archive, zs.index, 0);
	134	zip_fread(zf, metafile, zs.size);
	135	zip_fclose(zf);
	136
	137	kf = g_key_file_new();
	138	if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
a885ce3e	139	sr_dbg("Failed to parse metadata.");
7d658874 BV	140	return SR_ERR;
	141	}
	142
2285cf9b	143	sr_session_new();
7d658874 BV	144
	145	devcnt = 0;
	146	capturefiles = g_ptr_array_new_with_free_func(g_free);
	147	sections = g_key_file_get_groups(kf, NULL);
	148	for (i = 0; sections[i]; i++) {
	149	if (!strcmp(sections[i], "global"))
	150	/* nothing really interesting in here yet */
	151	continue;
	152	if (!strncmp(sections[i], "device ", 7)) {
	153	/* device section */
4d684427	154	sdi = NULL;
003595ac	155	enabled_probes = total_probes = 0;
7d658874 BV	156	keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
	157	for (j = 0; keys[j]; j++) {
	158	val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
	159	if (!strcmp(keys[j], "capturefile")) {
4d684427 BV	160	sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
4d684427 BV	161	sdi->driver = &session_driver;
7d658874	162	if (devcnt == 0)
c09f0b57	163	/* first device, init the driver */
44fc870c	164	sdi->driver->init(NULL);
bd7bfe8c	165	sr_dev_open(sdi);
4d684427	166	sr_session_dev_add(sdi);
003595ac	167	sdi->driver->config_set(SR_CONF_SESSIONFILE,
8f996b89	168	g_variant_new_string(filename), sdi, NULL);
003595ac	169	sdi->driver->config_set(SR_CONF_CAPTUREFILE,
8f996b89	170	g_variant_new_string(val), sdi, NULL);
7d658874 BV	171	g_ptr_array_add(capturefiles, val);
7d658874 BV	172	} else if (!strcmp(keys[j], "samplerate")) {
f64c1414	173	sr_parse_sizestring(val, &tmp_u64);
003595ac	174	sdi->driver->config_set(SR_CONF_SAMPLERATE,
8f996b89	175	g_variant_new_uint64(tmp_u64), sdi, NULL);
7d658874 BV	176	} else if (!strcmp(keys[j], "unitsize")) {
7d658874 BV	177	tmp_u64 = strtoull(val, NULL, 10);
003595ac	178	sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
8f996b89	179	g_variant_new_uint64(tmp_u64), sdi, NULL);
7d658874 BV	180	} else if (!strcmp(keys[j], "total probes")) {
7d658874 BV	181	total_probes = strtoull(val, NULL, 10);
003595ac	182	sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
8f996b89	183	g_variant_new_uint64(total_probes), sdi, NULL);
464d12c7 KS	184	for (p = 0; p < total_probes; p++) {
464d12c7 KS	185	snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
fb381e4d	186	if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
4d684427 BV	187	probename)))
	188	return SR_ERR;
	189	sdi->probes = g_slist_append(sdi->probes, probe);
464d12c7	190	}
7d658874	191	} else if (!strncmp(keys[j], "probe", 5)) {
4d684427	192	if (!sdi)
7d658874 BV	193	continue;
	194	enabled_probes++;
	195	tmp_u64 = strtoul(keys[j]+5, NULL, 10);
fb381e4d BV	196	/* sr_session_save() */
fb381e4d BV	197	sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
7d658874 BV	198	} else if (!strncmp(keys[j], "trigger", 7)) {
7d658874 BV	199	probenum = strtoul(keys[j]+7, NULL, 10);
4d684427	200	sr_dev_trigger_set(sdi, probenum, val);
7d658874 BV	201	}
	202	}
	203	g_strfreev(keys);
fb381e4d	204	/* Disable probes not specifically listed. */
003595ac BV	205	if (total_probes)
	206	for (p = enabled_probes; p < total_probes; p++)
	207	sr_dev_probe_enable(sdi, p, FALSE);
7d658874	208	}
4d684427	209	devcnt++;
7d658874 BV	210	}
	211	g_strfreev(sections);
	212	g_key_file_free(kf);
	213
	214	return SR_OK;
	215	}
	216
9f45fb3a UH	217	/**
	218	* Save the current session to the specified file.
	219	*
18bc2704	220	* @param filename The name of the filename to save the current session as.
9f45fb3a	221	* Must not be NULL.
056be071	222	* @param sdi The device instance from which the data was captured.
18bc2704 BV	223	* @param buf The data to be saved.
	224	* @param unitsize The number of bytes per sample.
	225	* @param units The number of samples.
9f45fb3a UH	226	*
	227	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
	228	* upon other errors.
	229	*/
18bc2704 BV	230	SR_API int sr_session_save(const char filename, const struct sr_dev_inst sdi,
18bc2704 BV	231	unsigned char *buf, int unitsize, int units)
7d658874	232	{
18bc2704	233	GSList *l;
003595ac	234	GVariant *gvar;
7d658874	235	FILE *meta;
1afe8989	236	struct sr_probe *probe;
7d658874 BV	237	struct zip *zipfile;
7d658874 BV	238	struct zip_source versrc, metasrc, *logicsrc;
18bc2704	239	int tmpfile, ret, probecnt;
003595ac	240	uint64_t samplerate;
18bc2704	241	char version[1], rawname[16], metafile[32], *s;
7d658874	242
9f45fb3a	243	if (!filename) {
a885ce3e	244	sr_err("%s: filename was NULL", __func__);
9f45fb3a UH	245	return SR_ERR_ARG;
	246	}
	247
7d658874	248	/* Quietly delete it first, libzip wants replace ops otherwise. */
4a1b18f8	249	unlink(filename);
ebc34738	250	if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
7d658874	251	return SR_ERR;
7d658874 BV	252
	253	/* "version" */
	254	version[0] = '1';
	255	if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
	256	return SR_ERR;
	257	if (zip_add(zipfile, "version", versrc) == -1) {
a885ce3e	258	sr_info("error saving version into zipfile: %s",
b08024a8	259	zip_strerror(zipfile));
7d658874 BV	260	return SR_ERR;
	261	}
	262
	263	/* init "metadata" */
	264	strcpy(metafile, "sigrok-meta-XXXXXX");
	265	if ((tmpfile = g_mkstemp(metafile)) == -1)
	266	return SR_ERR;
	267	close(tmpfile);
868d8cef	268	meta = g_fopen(metafile, "wb");
7d658874 BV	269	fprintf(meta, "[global]\n");
7d658874 BV	270	fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
7d658874	271
056be071 BV	272	/* metadata */
	273	fprintf(meta, "[device 1]\n");
	274	if (sdi->driver)
	275	fprintf(meta, "driver = %s\n", sdi->driver->name);
7d658874	276
056be071 BV	277	/* metadata */
056be071 BV	278	fprintf(meta, "capturefile = logic-1\n");
18bc2704	279	fprintf(meta, "unitsize = %d\n", unitsize);
056be071	280	fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
4d15e5c9	281	if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
8f996b89 ML	282	if (sr_config_get(sdi->driver, sdi, NULL,
8f996b89 ML	283	SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
003595ac BV	284	samplerate = g_variant_get_uint64(gvar);
003595ac BV	285	s = sr_samplerate_string(samplerate);
056be071 BV	286	fprintf(meta, "samplerate = %s\n", s);
056be071 BV	287	g_free(s);
003595ac	288	g_variant_unref(gvar);
056be071 BV	289	}
	290	}
	291	probecnt = 1;
	292	for (l = sdi->probes; l; l = l->next) {
	293	probe = l->data;
	294	if (probe->enabled) {
	295	if (probe->name)
	296	fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
	297	if (probe->trigger)
	298	fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
	299	probecnt++;
	300	}
	301	}
7d658874	302
056be071	303	if (!(logicsrc = zip_source_buffer(zipfile, buf,
18bc2704	304	units * unitsize, FALSE)))
056be071 BV	305	return SR_ERR;
	306	snprintf(rawname, 15, "logic-1");
	307	if (zip_add(zipfile, rawname, logicsrc) == -1)
	308	return SR_ERR;
7d658874 BV	309	fclose(meta);
	310
	311	if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
	312	return SR_ERR;
	313	if (zip_add(zipfile, "metadata", metasrc) == -1)
	314	return SR_ERR;
	315
	316	if ((ret = zip_close(zipfile)) == -1) {
a885ce3e	317	sr_info("error saving zipfile: %s", zip_strerror(zipfile));
7d658874 BV	318	return SR_ERR;
	319	}
	320
	321	unlink(metafile);
	322
	323	return SR_OK;
	324	}
7b870c38	325
f438e0c9 BV	326	/**
	327	* Append data to an existing session file.
	328	*
	329	* @param filename The name of the filename to append to. Must not be NULL.
	330	* @param buf The data to be appended.
	331	* @param unitsize The number of bytes per sample.
	332	* @param units The number of samples.
	333	*
	334	* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
	335	* upon other errors.
	336	*/
	337	SR_API int sr_session_append(const char filename, unsigned char buf,
	338	int unitsize, int units)
	339	{
	340	struct zip *archive;
	341	struct zip_source *logicsrc;
	342	zip_int64_t num_files;
	343	int chunk_num, next_chunk_num, ret, i;
	344	const char *entry_name;
	345	char chunkname[16];
	346
	347	if ((ret = sr_sessionfile_check(filename)) != SR_OK)
	348	return ret;
	349
	350	if (!(archive = zip_open(filename, 0, &ret)))
	351	return SR_ERR;
	352
	353	next_chunk_num = 1;
	354	num_files = zip_get_num_entries(archive, 0);
	355	for (i = 0; i < num_files; i++) {
	356	entry_name = zip_get_name(archive, i, 0);
	357	if (strncmp(entry_name, "logic-1", 7))
	358	continue;
	359	if (strlen(entry_name) == 7) {
	360	/* This file has no extra chunks, just a single "logic-1".
	361	* Rename it to "logic-1-1" * and continue with chunk 2. */
	362	if (zip_rename(archive, i, "logic-1-1") == -1) {
	363	sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
	364	return SR_ERR;
	365	}
	366	next_chunk_num = 2;
	367	break;
	368	} else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
	369	chunk_num = strtoull(entry_name + 8, NULL, 10);
	370	if (chunk_num >= next_chunk_num)
	371	next_chunk_num = chunk_num + 1;
	372	}
	373	}
	374	snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
	375	if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE)))
	376	return SR_ERR;
	377	if (zip_add(archive, chunkname, logicsrc) == -1)
	378	return SR_ERR;
	379	if ((ret = zip_close(archive)) == -1) {
	380	sr_info("error saving session file: %s", zip_strerror(archive));
	381	return SR_ERR;
	382	}
	383
	384	return SR_OK;
	385	}
	386
7b870c38	387	/** @} */