]> sigrok.org Git - libsigrok.git/blobdiff - output/output_gnuplot.c
gnuplot output: Optimize by only storing changes.
[libsigrok.git] / output / output_gnuplot.c
index 25306d8d865149ac5972bb69e4699d384d7de3ad..dfa91eb78b39f8a8db1638cba7409bf497684572 100644 (file)
 #include <string.h>
 #include <glib.h>
 #include <sigrok.h>
+#include <sigrok-internal.h>
 #include "config.h"
 
 struct context {
-       int num_enabled_probes;
-       int unitsize;
-       char *probelist[65];
+       unsigned int num_enabled_probes;
+       unsigned int unitsize;
+       char *probelist[SR_MAX_NUM_PROBES + 1];
        char *header;
 };
 
-const char *gnuplot_header = "\
+#define MAX_HEADER_LEN \
+       (1024 + (SR_MAX_NUM_PROBES * (SR_MAX_PROBENAME_LEN + 10)))
+
+static const char *gnuplot_header = "\
 # Sample data in space-separated columns format usable by gnuplot\n\
 #\n\
-# Generated by: %s on %s\n\
-# Comment: Acquisition with %d/%d probes at %s\n\
-# Timescale: %d %s\n\
-# Column assignment:\n%s\n";
+# Generated by: %s on %s%s\
+# Period: %s\n\
+#\n\
+# Column\tProbe\n\
+# -------------------------------------\
+----------------------------------------\n\
+# 0\t\tSample counter (for internal gnuplot purposes)\n%s\n";
 
-static int init(struct output *o)
-{
-/* Maximum header length */
-#define MAX_HEADER_LEN 2048
+static const char *gnuplot_header_comment = "\
+# Comment: Acquisition with %d/%d probes at %s\n";
 
+static int init(struct sr_output *o)
+{
        struct context *ctx;
-       struct probe *probe;
+       struct sr_probe *probe;
        GSList *l;
        uint64_t samplerate;
-       int i, b, num_probes;
-       char *c;
-       char sbuf[10], wbuf[1000];
+       unsigned int i;
+       int b, num_probes;
+       char *c, *frequency_s;
+       char wbuf[1000], comment[128];
+       time_t t;
+
+       if (!o) {
+               sr_warn("gnuplot out: %s: o was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!o->device) {
+               sr_warn("gnuplot out: %s: o->device was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!o->device->plugin) {
+               sr_warn("gnuplot out: %s: o->device->plugin was NULL",
+                       __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!(ctx = calloc(1, sizeof(struct context)))) {
+               sr_warn("gnuplot out: %s: ctx calloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
+               sr_warn("gnuplot out: %s: ctx->header calloc failed",
+                       __func__);
+               free(ctx);
+               return SR_ERR_MALLOC;
+       }
 
-       ctx = malloc(sizeof(struct context));
-       if (ctx == NULL)
-               return SIGROK_ERR_MALLOC;
        o->internal = ctx;
        ctx->num_enabled_probes = 0;
        for (l = o->device->probes; l; l = l->next) {
-               probe = l->data;
-               if (probe->enabled)
-                       ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+               probe = l->data; /* TODO: Error checks. */
+               if (!probe->enabled)
+                       continue;
+               ctx->probelist[ctx->num_enabled_probes++] = probe->name;
        }
-
        ctx->probelist[ctx->num_enabled_probes] = 0;
        ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
 
-       /* TODO: Allow for configuration via o->param. */
-
-       ctx->header = calloc(1, MAX_HEADER_LEN + 1);
-       if (ctx->header == NULL)
-               return SIGROK_ERR_MALLOC;
        num_probes = g_slist_length(o->device->probes);
-       /* TODO: Handle num_probes == 0, too many probes, etc. */
-       samplerate = *((uint64_t *) o->device->plugin->get_device_info(
-                       o->device->plugin_index, DI_CUR_SAMPLERATE));
-
-       /* Samplerate string */
-       if (samplerate >= GHZ(1))
-               snprintf(sbuf, 10, "%"PRIu64" GHz", samplerate / 1000000000);
-       else if (samplerate >= MHZ(1))
-               snprintf(sbuf, 10, "%"PRIu64" MHz", samplerate / 1000000);
-       else if (samplerate >= KHZ(1))
-               snprintf(sbuf, 10, "%"PRIu64" KHz", samplerate / 1000);
-       else
-               snprintf(sbuf, 10, "%"PRIu64" Hz", samplerate);
+       comment[0] = '\0';
+       if (sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
+               samplerate = *((uint64_t *) o->device->plugin->get_device_info(
+                               o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
+               if (!(frequency_s = sr_samplerate_string(samplerate))) {
+                       sr_warn("gnuplot out: %s: sr_samplerate_string failed",
+                               __func__);
+                       free(ctx->header);
+                       free(ctx);
+                       return SR_ERR;
+               }
+               snprintf(comment, 127, gnuplot_header_comment,
+                       ctx->num_enabled_probes, num_probes, frequency_s);
+               free(frequency_s);
+       }
 
        /* Columns / channels */
        wbuf[0] = '\0';
        for (i = 0; i < ctx->num_enabled_probes; i++) {
                c = (char *)&wbuf + strlen((char *)&wbuf);
-               sprintf(c, "# Column %d: channel %s\n", i, ctx->probelist[i]);
+               sprintf(c, "# %d\t\t%s\n", i + 1, ctx->probelist[i]);
        }
 
-       /* TODO: date: File or signals? Make y/n configurable. */
-       /* TODO: Timescale */
+       if (!(frequency_s = sr_period_string(samplerate))) {
+               sr_warn("gnuplot out: %s: sr_period_string failed", __func__);
+               free(ctx->header);
+               free(ctx);
+               return SR_ERR;
+       }
+
+       t = time(NULL);
        b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
-                    PACKAGE_STRING, "TODO", ctx->num_enabled_probes,
-                    num_probes, (char *)&sbuf, 1, "ns", (char *)&wbuf);
+                    PACKAGE_STRING, ctime(&t), comment, frequency_s,
+                    (char *)&wbuf);
+       free(frequency_s);
 
-       /* TODO: Handle snprintf errors. */
+       if (b < 0) {
+               sr_warn("gnuplot out: %s: sprintf failed", __func__);
+               free(ctx->header);
+               free(ctx);
+               return SR_ERR;
+       }
 
        return 0;
 }
 
-static int event(struct output *o, int event_type, char **data_out,
+static int event(struct sr_output *o, int event_type, char **data_out,
                 uint64_t *length_out)
 {
        struct context *ctx;
-       char *outbuf;
-       int outlen = 1; /* FIXME */
+
+       if (!o) {
+               sr_warn("gnuplot out: %s: o was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!data_out) {
+               sr_warn("gnuplot out: %s: data_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!length_out) {
+               sr_warn("gnuplot out: %s: length_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
 
        ctx = o->internal;
-       switch(event_type) {
-       case DF_TRIGGER:
+
+       switch (event_type) {
+       case SR_DF_TRIGGER:
+               /* TODO: Can a trigger mark be in a gnuplot data file? */
                break;
-       case DF_END:
-               outbuf = calloc(1, 1); // FIXME
-               if (outbuf == NULL)
-                       return SIGROK_ERR_MALLOC;
-               *data_out = outbuf;
-               *length_out = outlen;
+       case SR_DF_END:
                free(o->internal);
                o->internal = NULL;
                break;
+       default:
+               sr_warn("gnuplot out: %s: unsupported event type: %d",
+                       __func__, event_type);
+               break;
        }
 
-       return SIGROK_OK;
+       *data_out = NULL;
+       *length_out = 0;
+
+       return SR_OK;
 }
 
-static int data(struct output *o, char *data_in, uint64_t length_in,
+static int data(struct sr_output *o, const char *data_in, uint64_t length_in,
                char **data_out, uint64_t *length_out)
 {
        struct context *ctx;
-       int offset, outsize, p, curbit;
-       uint64_t sample, count = 0;
+       unsigned int max_linelen, outsize, p, curbit, i;
+       uint64_t sample;
+       static uint64_t samplecount = 0, old_sample = 0;
        char *outbuf, *c;
 
+       if (!o) {
+               sr_warn("gnuplot out: %s: o was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!o->internal) {
+               sr_warn("gnuplot out: %s: o->internal was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!data_in) {
+               sr_warn("gnuplot out: %s: data_in was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!data_out) {
+               sr_warn("gnuplot out: %s: data_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!length_out) {
+               sr_warn("gnuplot out: %s: length_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
        ctx = o->internal;
-       outsize = strlen(ctx->header);
-       outbuf = calloc(1, outsize + 1 + 10000); // FIXME: Use realloc().
-       if (outbuf == NULL)
-               return SIGROK_ERR_MALLOC;
+       max_linelen = 16 + ctx->num_enabled_probes * 2;
+       outsize = length_in / ctx->unitsize * max_linelen;
+       if (ctx->header)
+               outsize += strlen(ctx->header);
+
+       if (!(outbuf = calloc(1, outsize))) {
+               sr_warn("gnuplot out: %s: outbuf calloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       outbuf[0] = '\0';
        if (ctx->header) {
                /* The header is still here, this must be the first packet. */
                strncpy(outbuf, ctx->header, outsize);
                free(ctx->header);
                ctx->header = NULL;
-       } else {
-               outbuf[0] = 0;
        }
 
-       /* TODO: Are disabled probes handled correctly? */
+       for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
+
+               memcpy(&sample, data_in + i, ctx->unitsize);
 
-       for (offset = 0; offset <= length_in - ctx->unitsize;
-                                               offset += ctx->unitsize) {
-               memcpy(&sample, data_in + offset, ctx->unitsize);
+               /*
+                * Don't output the same samples multiple times. However, make
+                * sure to output at least the first and last sample.
+                */
+               if (samplecount++ != 0 && sample == old_sample) {
+                       if (i != (length_in - ctx->unitsize))
+                               continue;
+               }
+               old_sample = sample;
 
                /* The first column is a counter (needed for gnuplot). */
                c = outbuf + strlen(outbuf);
-               sprintf(c, "%"PRIu64"\t\t", count++);
+               sprintf(c, "%" PRIu64 "\t", samplecount++);
 
                /* The next columns are the values of all channels. */
                for (p = 0; p < ctx->num_enabled_probes; p++) {
-                       curbit = (sample & ((uint64_t) (1 << p))) != 0;
+                       curbit = (sample & ((uint64_t) (1 << p))) >> p;
                        c = outbuf + strlen(outbuf);
                        sprintf(c, "%d ", curbit);
                }
 
                c = outbuf + strlen(outbuf);
                sprintf(c, "\n");
+       }
+
+       *data_out = outbuf;
+       *length_out = strlen(outbuf);
 
-               /* TODO: realloc() if strlen(outbuf) is almost "full"... */
+       return SR_OK;
+}
+
+struct sr_output_format output_gnuplot = {
+       .id = "gnuplot",
+       .description = "Gnuplot",
+       .df_type = SR_DF_LOGIC,
+       .init = init,
+       .data = data,
+       .event = event,
+};
+
+/* Temporarily disabled. */
+#if 0
+static int analog_init(struct sr_output *o)
+{
+       struct context *ctx;
+       struct sr_probe *probe;
+       GSList *l;
+       uint64_t samplerate;
+       unsigned int i;
+       int b, num_probes;
+       char *c, *frequency_s;
+       char wbuf[1000], comment[128];
+       time_t t;
+
+       if (!(ctx = calloc(1, sizeof(struct context))))
+               return SR_ERR_MALLOC;
+
+       if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
+               free(ctx);
+               return SR_ERR_MALLOC;
+       }
+
+       o->internal = ctx;
+       ctx->num_enabled_probes = 0;
+       for (l = o->device->probes; l; l = l->next) {
+               probe = l->data;
+               if (!probe->enabled)
+                       continue;
+               ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+       }
+       ctx->probelist[ctx->num_enabled_probes] = 0;
+//     ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
+       ctx->unitsize = sizeof(struct sr_analog_sample) +
+                       (ctx->num_enabled_probes * sizeof(struct sr_analog_probe));
+
+       num_probes = g_slist_length(o->device->probes);
+       comment[0] = '\0';
+       if (o->device->plugin && sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
+               samplerate = *((uint64_t *) o->device->plugin->get_device_info(
+                               o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
+               if (!(frequency_s = sr_samplerate_string(samplerate))) {
+                       free(ctx->header);
+                       free(ctx);
+                       return SR_ERR;
+               }
+               snprintf(comment, 127, gnuplot_header_comment,
+                       ctx->num_enabled_probes, num_probes, frequency_s);
+               free(frequency_s);
+       }
+
+       /* Columns / channels */
+       wbuf[0] = '\0';
+       for (i = 0; i < ctx->num_enabled_probes; i++) {
+               c = (char *)&wbuf + strlen((char *)&wbuf);
+               sprintf(c, "# %d\t\t%s\n", i + 1, ctx->probelist[i]);
+       }
+
+       if (!(frequency_s = sr_period_string(samplerate))) {
+               free(ctx->header);
+               free(ctx);
+               return SR_ERR;
+       }
+       t = time(NULL);
+       b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
+                    PACKAGE_STRING, ctime(&t), comment, frequency_s,
+                    (char *)&wbuf);
+       free(frequency_s);
+
+       if (b < 0) {
+               free(ctx->header);
+               free(ctx);
+               return SR_ERR;
+       }
+
+       return 0;
+}
+
+static int analog_data(struct sr_output *o, char *data_in, uint64_t length_in,
+               char **data_out, uint64_t *length_out)
+{
+       struct context *ctx;
+       unsigned int max_linelen, outsize, p, /* curbit, */ i;
+//     uint64_t sample;
+       static uint64_t samplecount = 0;
+       char *outbuf, *c;
+       struct sr_analog_sample *sample;
+
+       ctx = o->internal;
+//     max_linelen = 16 + ctx->num_enabled_probes * 2;
+       max_linelen = 16 + ctx->num_enabled_probes * 30;
+       outsize = length_in / ctx->unitsize * max_linelen;
+       if (ctx->header)
+               outsize += strlen(ctx->header);
+
+       if (!(outbuf = calloc(1, outsize)))
+               return SR_ERR_MALLOC;
+
+       outbuf[0] = '\0';
+       if (ctx->header) {
+               /* The header is still here, this must be the first packet. */
+               strncpy(outbuf, ctx->header, outsize);
+               free(ctx->header);
+               ctx->header = NULL;
+       }
+
+       for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
+//             memcpy(&sample, data_in + i, ctx->unitsize);
+               sample = (struct sr_analog_sample *) (data_in + i);
+
+               /* The first column is a counter (needed for gnuplot). */
+               c = outbuf + strlen(outbuf);
+               sprintf(c, "%" PRIu64 "\t", samplecount++);
+
+               /* The next columns are the values of all channels. */
+               for (p = 0; p < ctx->num_enabled_probes; p++) {
+//                     curbit = (sample & ((uint64_t) (1 << p))) >> p;
+                       c = outbuf + strlen(outbuf);
+//                     sprintf(c, "%d ", curbit);
+                       /*
+                        * FIXME: Should be doing proper raw->voltage conversion
+                        * here, casting to int16_t isn't it. Remember that if
+                        * res = 1 conversion isn't necessary.
+                        */
+                       sprintf(c, "%f ", (double) ((int16_t) (sample->probes[p].val &
+                                       ((1 << sample->probes[p].res) - 1))));
+               }
+
+               c = outbuf + strlen(outbuf);
+               sprintf(c, "\n");
        }
 
        *data_out = outbuf;
        *length_out = strlen(outbuf);
 
-       return SIGROK_OK;
+       return SR_OK;
 }
 
-struct output_format output_gnuplot = {
-       "gnuplot",
-       "Gnuplot",
-       init,
-       data,
-       event,
+struct sr_output_format output_analog_gnuplot = {
+       .id = "analog_gnuplot",
+       .description = "Gnuplot analog",
+       .df_type = SR_DF_ANALOG,
+       .init = analog_init,
+       .data = analog_data,
+       .event = event,
 };
+#endif