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

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