]> sigrok.org Git - libsigrok.git/blobdiff - session_file.c
Initial Comma-separated values (CSV) input support.
[libsigrok.git] / session_file.c
index 12c0bf863832d4d5afbeb56dec2f0d55aeb07459..6cd9b72025ad54a3146d40c8d1e856963d4fa23e 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 "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)
+/* 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
 extern struct sr_session *session;
 extern SR_PRIV struct sr_dev_driver session_driver;
 
-/**
- * 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)
+/** @private */
+SR_PRIV int sr_sessionfile_check(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, version, i, j;
-       uint64_t tmp_u64, total_probes, enabled_probes, p;
-       char **sections, **keys, *metafile, *val, s[11];
-       char probename[SR_MAX_PROBENAME_LEN + 1];
+       int version, ret;
+       char s[11];
 
-       if (!filename) {
-               sr_err("%s: filename was NULL", __func__);
+       if (!filename)
                return SR_ERR_ARG;
-       }
 
-       if (!(archive = zip_open(filename, 0, &ret))) {
-               sr_dbg("Failed to open session file: zip error %d", ret);
+       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.");
+               sr_dbg("Not a sigrok session file: no version found.");
                return SR_ERR;
        }
-       if ((ret = zip_fread(zf, s, 10)) == -1) {
-               sr_dbg("Not a valid sigrok session file.");
+       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("Not a valid sigrok session file version.");
+               sr_dbg("Cannot handle sigrok session file version %d.", version);
                return SR_ERR;
        }
 
@@ -108,6 +90,41 @@ SR_API int sr_session_load(const char *filename)
                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;
@@ -135,7 +152,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);
@@ -144,20 +161,26 @@ 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_dev_open(sdi);
                                        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,
@@ -179,8 +202,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++;
        }
@@ -193,25 +217,28 @@ 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("%s: filename was NULL", __func__);
@@ -249,14 +276,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;
@@ -271,22 +300,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("%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)
@@ -308,4 +323,65 @@ SR_API int sr_session_save(const char *filename,
        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;
+}
+
 /** @} */