X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=session_file.c;h=46b12e32324a926db50c6cc841adfd5dace4a43e;hb=50985c2019b2b5a6ce394589d89ee925b4f5e3a9;hp=0e3c56bec13be086a4cf7ce10f725c17363773a2;hpb=b53738baf76219237e0a6629905981d7a1f2508e;p=libsigrok.git diff --git a/session_file.c b/session_file.c index 0e3c56be..46b12e32 100644 --- a/session_file.c +++ b/session_file.c @@ -1,7 +1,7 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * - * Copyright (C) 2011 Bert Vermeulen + * Copyright (C) 2013 Bert Vermeulen * * 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 @@ -17,49 +17,90 @@ * along with this program. If not, see . */ -#include "config.h" #include #include #include #include #include #include -#include -#include +#include "config.h" /* Needed for PACKAGE_VERSION and others. */ +#include "libsigrok.h" +#include "libsigrok-internal.h" + +/* Message logging helpers with driver-specific prefix string. */ +#define DRIVER_LOG_DOMAIN "session-file: " +#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) +#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) +#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) +#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) +#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) +#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) + +/** + * @file + * + * Loading and saving libsigrok session files. + */ + +/** + * @addtogroup grp_session + * + * @{ + */ extern struct sr_session *session; -extern struct sr_device_plugin session_driver; +extern SR_PRIV struct sr_dev_driver session_driver; -int sr_session_load(const char *filename) +/** + * 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_session *session; - struct sr_device *device; + struct sr_dev_inst *sdi; struct sr_probe *probe; - int ret, err, probenum, devcnt, i, j; + int ret, probenum, devcnt, version, i, j; uint64_t tmp_u64, total_probes, enabled_probes, p; - char **sections, **keys, *metafile, *val, c; + char **sections, **keys, *metafile, *val, s[11]; + char probename[SR_MAX_PROBENAME_LEN + 1]; + + if (!filename) { + sr_err("%s: filename was NULL", __func__); + return SR_ERR_ARG; + } - if (!(archive = zip_open(filename, 0, &err))) { - sr_dbg("Failed to open session file: zip error %d", err); + if (!(archive = zip_open(filename, 0, &ret))) { + sr_dbg("Failed to open session file: zip error %d", ret); return SR_ERR; } /* check "version" */ + version = 0; if (!(zf = zip_fopen(archive, "version", 0))) { sr_dbg("Not a sigrok session file."); return SR_ERR; } - ret = zip_fread(zf, &c, 1); - if (ret != 1 || c != '1') { + if ((ret = zip_fread(zf, s, 10)) == -1) { sr_dbg("Not a valid sigrok session file."); return SR_ERR; } zip_fclose(zf); + s[ret] = 0; + version = strtoull(s, NULL, 10); + if (version != 1) { + sr_dbg("Not a valid sigrok session file version."); + return SR_ERR; + } /* read "metadata" */ if (zip_stat(archive, "metadata", 0, &zs) == -1) { @@ -68,7 +109,7 @@ int sr_session_load(const char *filename) } if (!(metafile = g_try_malloc(zs.size))) { - sr_err("session file: %s: metafile malloc failed", __func__); + sr_err("%s: metafile malloc failed", __func__); return SR_ERR_MALLOC; } @@ -82,7 +123,7 @@ int sr_session_load(const char *filename) return SR_ERR; } - session = sr_session_new(); + sr_session_new(); devcnt = 0; capturefiles = g_ptr_array_new_with_free_func(g_free); @@ -93,47 +134,61 @@ int sr_session_load(const char *filename) continue; if (!strncmp(sections[i], "device ", 7)) { /* device section */ - device = NULL; - enabled_probes = 0; + 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")) { - device = sr_device_new(&session_driver, devcnt, 0); + sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL); + sdi->driver = &session_driver; if (devcnt == 0) - /* first device, init the plugin */ - device->plugin->init((char *)filename); - sr_session_device_add(device); - device->plugin->set_configuration(devcnt, SR_HWCAP_CAPTUREFILE, val); + /* first device, init the driver */ + sdi->driver->init(NULL); + 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")) { - tmp_u64 = sr_parse_sizestring(val); - device->plugin->set_configuration(devcnt, SR_HWCAP_SAMPLERATE, &tmp_u64); + 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); - device->plugin->set_configuration(devcnt, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64); + 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); - device->plugin->set_configuration(devcnt, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes); - for (p = 1; p <= total_probes; p++) - sr_device_probe_add(device, NULL); + 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 (!device) + if (!sdi) continue; enabled_probes++; tmp_u64 = strtoul(keys[j]+5, NULL, 10); - sr_device_probe_name(device, tmp_u64, val); + /* 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_device_trigger_set(device, probenum, val); + sr_dev_trigger_set(sdi, probenum, val); } } g_strfreev(keys); - for (p = enabled_probes; p < total_probes; p++) { - probe = g_slist_nth_data(device->probes, p); - probe->enabled = FALSE; - } + /* 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); @@ -141,22 +196,40 @@ int sr_session_load(const char *filename) return SR_OK; } -int sr_session_save(const char *filename) +/** + * 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, *p, *d; + GSList *l; + GVariant *gvar; FILE *meta; - struct sr_device *device; struct sr_probe *probe; - struct sr_datastore *ds; struct zip *zipfile; struct zip_source *versrc, *metasrc, *logicsrc; - int bufcnt, devcnt, tmpfile, ret, error, probecnt; + int tmpfile, ret, probecnt; uint64_t samplerate; - char version[1], rawname[16], metafile[32], *buf, *s; + 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, &error))) + if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret))) return SR_ERR; /* "version" */ @@ -177,60 +250,44 @@ int sr_session_save(const char *filename) meta = g_fopen(metafile, "wb"); fprintf(meta, "[global]\n"); fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION); - /* TODO: save protocol decoders used */ - - /* all datastores in all devices */ - devcnt = 1; - for (l = session->devices; l; l = l->next) { - device = l->data; - /* metadata */ - fprintf(meta, "[device %d]\n", devcnt); - if (device->plugin) - fprintf(meta, "driver = %s\n", device->plugin->name); - - ds = device->datastore; - if (ds) { - /* metadata */ - fprintf(meta, "capturefile = logic-%d\n", devcnt); - fprintf(meta, "unitsize = %d\n", ds->ds_unitsize); - fprintf(meta, "total probes = %d\n", g_slist_length(device->probes)); - if (sr_device_has_hwcap(device, SR_HWCAP_SAMPLERATE)) { - samplerate = *((uint64_t *) device->plugin->get_device_info( - device->plugin_index, SR_DI_CUR_SAMPLERATE)); - s = sr_samplerate_string(samplerate); - fprintf(meta, "samplerate = %s\n", s); - free(s); - } - probecnt = 1; - for (p = device->probes; p; p = p->next) { - probe = p->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++; - } - } - /* dump datastore into logic-n */ - buf = malloc(ds->num_units * ds->ds_unitsize + - DATASTORE_CHUNKSIZE); - bufcnt = 0; - for (d = ds->chunklist; d; d = d->next) { - memcpy(buf + bufcnt, d->data, - DATASTORE_CHUNKSIZE); - bufcnt += DATASTORE_CHUNKSIZE; - } - if (!(logicsrc = zip_source_buffer(zipfile, buf, - ds->num_units * ds->ds_unitsize, TRUE))) - return SR_ERR; - snprintf(rawname, 15, "logic-%d", devcnt); - if (zip_add(zipfile, rawname, logicsrc) == -1) - return SR_ERR; + /* 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++; } - devcnt++; } + + 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))) @@ -247,3 +304,5 @@ int sr_session_save(const char *filename) return SR_OK; } + +/** @} */