2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
25 #include <glib/gstdio.h>
26 #include "config.h" /* Needed for PACKAGE_VERSION and others. */
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
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)
42 * Loading and saving libsigrok session files.
46 * @addtogroup grp_session
51 extern struct sr_session *session;
52 extern SR_PRIV struct sr_dev_driver session_driver;
55 * Load the session from the specified filename.
57 * @param filename The name of the session file to load. Must not be NULL.
59 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
60 * SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
63 SR_API int sr_session_load(const char *filename)
66 GPtrArray *capturefiles;
70 struct sr_dev_inst *sdi;
71 struct sr_probe *probe;
72 int ret, probenum, devcnt, version, i, j;
73 uint64_t tmp_u64, total_probes, enabled_probes, p;
74 char **sections, **keys, *metafile, *val, s[11];
75 char probename[SR_MAX_PROBENAME_LEN + 1];
78 sr_err("%s: filename was NULL", __func__);
82 if (!(archive = zip_open(filename, 0, &ret))) {
83 sr_dbg("Failed to open session file: zip error %d", ret);
89 if (!(zf = zip_fopen(archive, "version", 0))) {
90 sr_dbg("Not a sigrok session file.");
93 if ((ret = zip_fread(zf, s, 10)) == -1) {
94 sr_dbg("Not a valid sigrok session file.");
99 version = strtoull(s, NULL, 10);
101 sr_dbg("Not a valid sigrok session file version.");
105 /* read "metadata" */
106 if (zip_stat(archive, "metadata", 0, &zs) == -1) {
107 sr_dbg("Not a valid sigrok session file.");
111 if (!(metafile = g_try_malloc(zs.size))) {
112 sr_err("%s: metafile malloc failed", __func__);
113 return SR_ERR_MALLOC;
116 zf = zip_fopen_index(archive, zs.index, 0);
117 zip_fread(zf, metafile, zs.size);
120 kf = g_key_file_new();
121 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
122 sr_dbg("Failed to parse metadata.");
129 capturefiles = g_ptr_array_new_with_free_func(g_free);
130 sections = g_key_file_get_groups(kf, NULL);
131 for (i = 0; sections[i]; i++) {
132 if (!strcmp(sections[i], "global"))
133 /* nothing really interesting in here yet */
135 if (!strncmp(sections[i], "device ", 7)) {
138 enabled_probes = total_probes = 0;
139 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
140 for (j = 0; keys[j]; j++) {
141 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
142 if (!strcmp(keys[j], "capturefile")) {
143 sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
144 sdi->driver = &session_driver;
146 /* first device, init the driver */
147 sdi->driver->init(NULL);
149 sr_session_dev_add(sdi);
150 sdi->driver->config_set(SR_CONF_SESSIONFILE,
151 g_variant_new_string(filename), sdi);
152 sdi->driver->config_set(SR_CONF_CAPTUREFILE,
153 g_variant_new_string(val), sdi);
154 g_ptr_array_add(capturefiles, val);
155 } else if (!strcmp(keys[j], "samplerate")) {
156 sr_parse_sizestring(val, &tmp_u64);
157 sdi->driver->config_set(SR_CONF_SAMPLERATE,
158 g_variant_new_uint64(tmp_u64), sdi);
159 } else if (!strcmp(keys[j], "unitsize")) {
160 tmp_u64 = strtoull(val, NULL, 10);
161 sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
162 g_variant_new_uint64(tmp_u64), sdi);
163 } else if (!strcmp(keys[j], "total probes")) {
164 total_probes = strtoull(val, NULL, 10);
165 sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
166 g_variant_new_uint64(total_probes), sdi);
167 for (p = 0; p < total_probes; p++) {
168 snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
169 if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
172 sdi->probes = g_slist_append(sdi->probes, probe);
174 } else if (!strncmp(keys[j], "probe", 5)) {
178 tmp_u64 = strtoul(keys[j]+5, NULL, 10);
179 /* sr_session_save() */
180 sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
181 } else if (!strncmp(keys[j], "trigger", 7)) {
182 probenum = strtoul(keys[j]+7, NULL, 10);
183 sr_dev_trigger_set(sdi, probenum, val);
187 /* Disable probes not specifically listed. */
189 for (p = enabled_probes; p < total_probes; p++)
190 sr_dev_probe_enable(sdi, p, FALSE);
194 g_strfreev(sections);
201 * Save the current session to the specified file.
203 * @param filename The name of the filename to save the current session as.
205 * @param sdi The device instance from which the data was captured.
206 * @param buf The data to be saved.
207 * @param unitsize The number of bytes per sample.
208 * @param units The number of samples.
210 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
213 SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
214 unsigned char *buf, int unitsize, int units)
219 struct sr_probe *probe;
221 struct zip_source *versrc, *metasrc, *logicsrc;
222 int tmpfile, ret, probecnt;
224 char version[1], rawname[16], metafile[32], *s;
227 sr_err("%s: filename was NULL", __func__);
231 /* Quietly delete it first, libzip wants replace ops otherwise. */
233 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
238 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
240 if (zip_add(zipfile, "version", versrc) == -1) {
241 sr_info("error saving version into zipfile: %s",
242 zip_strerror(zipfile));
246 /* init "metadata" */
247 strcpy(metafile, "sigrok-meta-XXXXXX");
248 if ((tmpfile = g_mkstemp(metafile)) == -1)
251 meta = g_fopen(metafile, "wb");
252 fprintf(meta, "[global]\n");
253 fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
256 fprintf(meta, "[device 1]\n");
258 fprintf(meta, "driver = %s\n", sdi->driver->name);
261 fprintf(meta, "capturefile = logic-1\n");
262 fprintf(meta, "unitsize = %d\n", unitsize);
263 fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
264 if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
265 if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
266 &gvar, sdi) == SR_OK) {
267 samplerate = g_variant_get_uint64(gvar);
268 s = sr_samplerate_string(samplerate);
269 fprintf(meta, "samplerate = %s\n", s);
271 g_variant_unref(gvar);
275 for (l = sdi->probes; l; l = l->next) {
277 if (probe->enabled) {
279 fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
281 fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
286 if (!(logicsrc = zip_source_buffer(zipfile, buf,
287 units * unitsize, FALSE)))
289 snprintf(rawname, 15, "logic-1");
290 if (zip_add(zipfile, rawname, logicsrc) == -1)
294 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
296 if (zip_add(zipfile, "metadata", metasrc) == -1)
299 if ((ret = zip_close(zipfile)) == -1) {
300 sr_info("error saving zipfile: %s", zip_strerror(zipfile));