]> sigrok.org Git - libsigrok.git/blobdiff - output/output_gnuplot.c
input/output formats: s/extension/id/.
[libsigrok.git] / output / output_gnuplot.c
index 2c062397db98075c3167a45ba000b86c4433eeea..af24865f35adc598074ed999e2a15b67e3e7cb3c 100644 (file)
 struct context {
        unsigned int num_enabled_probes;
        unsigned int unitsize;
-       char *probelist[65];
+       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%s\
-# Timescale: %d %s\n\
+# Period: %s\n\
 #\n\
 # Column\tProbe\n\
 # -------------------------------------\
 ----------------------------------------\n\
 # 0\t\tSample counter (for internal gnuplot purposes)\n%s\n";
 
-const char *gnuplot_header_comment = "\
+static const char *gnuplot_header_comment = "\
 # Comment: Acquisition with %d/%d probes at %s\n";
 
-static int init(struct output *o)
+static int init(struct sr_output *o)
 {
-/* Maximum header length */
-#define MAX_HEADER_LEN 2048
-
        struct context *ctx;
-       struct probe *probe;
+       struct sr_probe *probe;
        GSList *l;
        uint64_t samplerate;
        unsigned int i;
        int b, num_probes;
-       char *c, *samplerate_s;
+       char *c, *frequency_s;
        char wbuf[1000], comment[128];
        time_t t;
 
        if (!(ctx = calloc(1, sizeof(struct context))))
-               return SIGROK_ERR_MALLOC;
+               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)
-                       ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+               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. */
-
-       if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
-               free(ctx);
-               return SIGROK_ERR_MALLOC;
-       }
-
        num_probes = g_slist_length(o->device->probes);
-       /* TODO: Handle num_probes == 0, too many probes, etc. */
-
        comment[0] = '\0';
-       if (o->device->plugin) {
+       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, DI_CUR_SAMPLERATE));
-               if (!(samplerate_s = sigrok_samplerate_string(samplerate))) {
+                               o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
+               if (!(frequency_s = sr_samplerate_string(samplerate))) {
                        free(ctx->header);
                        free(ctx);
-                       return SIGROK_ERR;
+                       return SR_ERR;
                }
                snprintf(comment, 127, gnuplot_header_comment,
-                        ctx->num_enabled_probes, num_probes, samplerate_s);
-               free(samplerate_s);
+                       ctx->num_enabled_probes, num_probes, frequency_s);
+               free(frequency_s);
        }
 
        /* Columns / channels */
@@ -105,55 +101,65 @@ static int init(struct output *o)
                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))) {
+               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, 1, "ns",
+                    PACKAGE_STRING, ctime(&t), comment, frequency_s,
                     (char *)&wbuf);
+       free(frequency_s);
 
-       /* TODO: Handle snprintf errors. */
+       if (b < 0) {
+               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;
 
        ctx = o->internal;
        switch (event_type) {
-       case DF_TRIGGER:
-               /* TODO */
+       case SR_DF_TRIGGER:
+               /* TODO: can a trigger mark be in a gnuplot data file? */
                break;
-       case DF_END:
-               *data_out = NULL;
-               *length_out = 0;
+       case SR_DF_END:
                free(o->internal);
                o->internal = NULL;
                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;
-       unsigned int i, outsize, p, curbit;
-       uint64_t sample, count = 0;
+       unsigned int max_linelen, outsize, p, curbit, i;
+       uint64_t sample;
+       static uint64_t samplecount = 0;
        char *outbuf, *c;
 
        ctx = o->internal;
-       outsize = 0;
+       max_linelen = 16 + ctx->num_enabled_probes * 2;
+       outsize = length_in / ctx->unitsize * max_linelen;
        if (ctx->header)
-               outsize = strlen(ctx->header);
+               outsize += strlen(ctx->header);
 
-       /* FIXME: Use realloc(). */
-       if (!(outbuf = calloc(1, outsize + 1 + 1000000)))
-               return SIGROK_ERR_MALLOC; /* TODO: free()? What to free? */
+       if (!(outbuf = calloc(1, outsize)))
+               return SR_ERR_MALLOC;
 
        outbuf[0] = '\0';
        if (ctx->header) {
@@ -163,38 +169,182 @@ static int data(struct output *o, char *data_in, uint64_t length_in,
                ctx->header = NULL;
        }
 
-       /* TODO: Are disabled probes handled correctly? */
-
        for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
                memcpy(&sample, data_in + i, ctx->unitsize);
 
                /* 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);
+
+       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;
+       }
 
-               /* TODO: realloc() if strlen(outbuf) is almost "full"... */
+       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