]> sigrok.org Git - libsigrok.git/blobdiff - session_file.c
GPL headers: Use correct project name.
[libsigrok.git] / session_file.c
index aae31a00b361e5173932b37e6d66c19662042db4..46b12e32324a926db50c6cc841adfd5dace4a43e 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * 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
 #include <zip.h>
 #include <glib.h>
 #include <glib/gstdio.h>
-#include "config.h"
+#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 SR_PRIV struct sr_dev_driver session_driver;
 
@@ -54,42 +75,41 @@ SR_API int sr_session_load(const char *filename)
        char probename[SR_MAX_PROBENAME_LEN + 1];
 
        if (!filename) {
-               sr_err("session file: %s: filename was NULL", __func__);
+               sr_err("%s: filename was NULL", __func__);
                return SR_ERR_ARG;
        }
 
        if (!(archive = zip_open(filename, 0, &ret))) {
-               sr_dbg("session file: Failed to open session file: zip "
-                      "error %d", 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("session file: Not a sigrok session file.");
+               sr_dbg("Not a sigrok session file.");
                return SR_ERR;
        }
        if ((ret = zip_fread(zf, s, 10)) == -1) {
-               sr_dbg("session file: Not a valid sigrok session file.");
+               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("session file: Not a valid sigrok session file version.");
+               sr_dbg("Not a valid sigrok session file version.");
                return SR_ERR;
        }
 
        /* read "metadata" */
        if (zip_stat(archive, "metadata", 0, &zs) == -1) {
-               sr_dbg("session file: Not a valid sigrok session file.");
+               sr_dbg("Not a valid sigrok session file.");
                return SR_ERR;
        }
 
        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;
        }
 
@@ -99,7 +119,7 @@ SR_API int sr_session_load(const char *filename)
 
        kf = g_key_file_new();
        if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
-               sr_dbg("session file: Failed to parse metadata.");
+               sr_dbg("Failed to parse metadata.");
                return SR_ERR;
        }
 
@@ -115,7 +135,7 @@ SR_API int sr_session_load(const char *filename)
                if (!strncmp(sections[i], "device ", 7)) {
                        /* device section */
                        sdi = NULL;
-                       enabled_probes = 0;
+                       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);
@@ -124,20 +144,25 @@ SR_API int sr_session_load(const char *filename)
                                        sdi->driver = &session_driver;
                                        if (devcnt == 0)
                                                /* first device, init the driver */
-                                               sdi->driver->init();
+                                               sdi->driver->init(NULL);
                                        sr_session_dev_add(sdi);
-                                       sdi->driver->dev_config_set(sdi, SR_HWCAP_SESSIONFILE, filename);
-                                       sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTUREFILE, val);
+                                       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->dev_config_set(sdi, SR_HWCAP_SAMPLERATE, &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->dev_config_set(sdi, 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);
-                                       sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes);
+                                       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,
@@ -159,8 +184,9 @@ SR_API int sr_session_load(const char *filename)
                        }
                        g_strfreev(keys);
                        /* Disable probes not specifically listed. */
-                       for (p = enabled_probes; p < total_probes; p++)
-                               sr_dev_probe_enable(sdi, p, FALSE);
+                       if (total_probes)
+                               for (p = enabled_probes; p < total_probes; p++)
+                                       sr_dev_probe_enable(sdi, p, FALSE);
                }
                devcnt++;
        }
@@ -173,28 +199,31 @@ SR_API int sr_session_load(const char *filename)
 /**
  * Save the current session to the specified file.
  *
- * @param filename The name of the file where to save the current session.
+ * @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 ds The datastore where the session's captured data was stored.
+ * @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, struct sr_datastore *ds)
+SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
+               unsigned char *buf, int unitsize, int units)
 {
-       GSList *l, *d;
+       GSList *l;
+       GVariant *gvar;
        FILE *meta;
        struct sr_probe *probe;
        struct zip *zipfile;
        struct zip_source *versrc, *metasrc, *logicsrc;
-       int bufcnt, tmpfile, ret, probecnt;
-       uint64_t *samplerate;
-       char version[1], rawname[16], metafile[32], *buf, *s;
+       int tmpfile, ret, probecnt;
+       uint64_t samplerate;
+       char version[1], rawname[16], metafile[32], *s;
 
        if (!filename) {
-               sr_err("session file: %s: filename was NULL", __func__);
+               sr_err("%s: filename was NULL", __func__);
                return SR_ERR_ARG;
        }
 
@@ -208,7 +237,7 @@ SR_API int sr_session_save(const char *filename,
        if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
                return SR_ERR;
        if (zip_add(zipfile, "version", versrc) == -1) {
-               sr_info("session file: error saving version into zipfile: %s",
+               sr_info("error saving version into zipfile: %s",
                        zip_strerror(zipfile));
                return SR_ERR;
        }
@@ -229,14 +258,16 @@ SR_API int sr_session_save(const char *filename,
 
        /* metadata */
        fprintf(meta, "capturefile = logic-1\n");
-       fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
+       fprintf(meta, "unitsize = %d\n", unitsize);
        fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
-       if (sr_dev_has_hwcap(sdi, SR_HWCAP_SAMPLERATE)) {
-               if (sr_info_get(sdi->driver, SR_DI_CUR_SAMPLERATE,
-                               (const void **)&samplerate, sdi) == SR_OK) {
-                       s = sr_samplerate_string(*samplerate);
+       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;
@@ -251,23 +282,8 @@ SR_API int sr_session_save(const char *filename,
                }
        }
 
-       /* dump datastore into logic-n */
-       buf = g_try_malloc(ds->num_units * ds->ds_unitsize +
-                  DATASTORE_CHUNKSIZE);
-       if (!buf) {
-               sr_err("session file: %s: buf malloc failed",
-                          __func__);
-               return SR_ERR_MALLOC;
-       }
-
-       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)))
+                          units * unitsize, FALSE)))
                return SR_ERR;
        snprintf(rawname, 15, "logic-1");
        if (zip_add(zipfile, rawname, logicsrc) == -1)
@@ -280,8 +296,7 @@ SR_API int sr_session_save(const char *filename,
                return SR_ERR;
 
        if ((ret = zip_close(zipfile)) == -1) {
-               sr_info("session file: error saving zipfile: %s",
-                       zip_strerror(zipfile));
+               sr_info("error saving zipfile: %s", zip_strerror(zipfile));
                return SR_ERR;
        }
 
@@ -289,3 +304,5 @@ SR_API int sr_session_save(const char *filename,
 
        return SR_OK;
 }
+
+/** @} */