]> sigrok.org Git - libsigrok.git/blobdiff - output/output_vcd.c
Constify some more 'char *' parameters.
[libsigrok.git] / output / output_vcd.c
index fd569e0edc280366cb5af87bc162ce2d2815d275..17505e6a2a1af10f2df1309db12430a38d255912 100644 (file)
@@ -2,6 +2,7 @@
  * This file is part of the sigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011 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
@@ -29,13 +30,16 @@ struct context {
        int unitsize;
        char *probelist[65];
        int *prevbits;
-       char *header;
+       GString *header;
+       uint64_t prevsample;
+       int period;
+       uint64_t samplerate;
 };
 
 const char *vcd_header = "\
-$date\n  %s\n$end\n\
-$version\n  %s\n$end\n%s\
-$timescale\n  %i %s\n$end\n\
+$date %s $end\n\
+$version %s $end\n%s\
+$timescale %s $end\n\
 $scope module %s $end\n\
 %s\
 $upscope $end\n\
@@ -45,173 +49,183 @@ $dumpvars\n";
 const char *vcd_header_comment = "\
 $comment\n  Acquisition with %d/%d probes at %s\n$end\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;
-       int i, b, num_probes;
-       char *c, *samplerate_s;
-       char wbuf[1000], comment[128];
+       int num_probes, i;
+       char *samplerate_s, *frequency_s, *timestamp;
+       time_t t;
 
        if (!(ctx = calloc(1, sizeof(struct context))))
-               return SIGROK_ERR_MALLOC;
+               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;
+       }
+       if (ctx->num_enabled_probes > 94) {
+               g_warning("VCD only supports 94 probes.");
+               return SR_ERR;
        }
 
        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;
-       }
+       ctx->header = g_string_sized_new(512);
        num_probes = g_slist_length(o->device->probes);
 
-       comment[0] = '\0';
-       if (o->device->plugin) {
-               /* TODO: Handle num_probes == 0, too many probes, etc. */
-               /* TODO: Error handling. */
-               samplerate = *((uint64_t *) o->device->plugin->get_device_info(
-                               o->device->plugin_index, DI_CUR_SAMPLERATE));
-               if (!((samplerate_s = sigrok_samplerate_string(samplerate)))) {
-                       free(ctx->header);
+       /* timestamp */
+       t = time(NULL);
+       timestamp = strdup(ctime(&t));
+       timestamp[strlen(timestamp)-1] = 0;
+       g_string_printf(ctx->header, "$date %s $end\n", timestamp);
+       free(timestamp);
+
+       /* generator */
+       g_string_append_printf(ctx->header, "$version %s %s $end\n",
+                       PACKAGE, PACKAGE_VERSION);
+
+       if (o->device->plugin && sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
+               ctx->samplerate = *((uint64_t *) o->device->plugin->get_device_info(
+                               o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
+               if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
+                       g_string_free(ctx->header, TRUE);
                        free(ctx);
-                       return SIGROK_ERR;
+                       return SR_ERR;
                }
-               /* TODO: Handle sprintf() errors. */
-               snprintf(comment, 127, vcd_header_comment,
-                        ctx->num_enabled_probes, num_probes, samplerate_s);
+               g_string_append_printf(ctx->header, vcd_header_comment,
+                                ctx->num_enabled_probes, num_probes, samplerate_s);
                free(samplerate_s);
        }
 
+       /* timescale */
+       /* VCD can only handle 1/10/100 (s - fs), so scale up first */
+       if (ctx->samplerate > MHZ(1))
+               ctx->period = GHZ(1);
+       else if (ctx->samplerate > KHZ(1))
+               ctx->period = MHZ(1);
+       else
+               ctx->period = KHZ(1);
+       if (!(frequency_s = sr_period_string(ctx->period))) {
+               g_string_free(ctx->header, TRUE);
+               free(ctx);
+               return SR_ERR;
+       }
+       g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
+       free(frequency_s);
+
+       /* scope */
+       g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
+
        /* Wires / channels */
-       wbuf[0] = '\0';
        for (i = 0; i < ctx->num_enabled_probes; i++) {
-               c = (char *)&wbuf + strlen((char *)&wbuf);
-               /* TODO: Needs fixing for very large number of probes. */
-               /* TODO: Handle sprintf() errors. */
-               sprintf(c, "$var wire 1 %c channel%s $end\n",
-                       (char)('!' + i), ctx->probelist[i]);
+               g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
+                               (char)('!' + i), ctx->probelist[i]);
        }
 
-       /* TODO: Date: File or signals? Make y/n configurable. */
-       b = snprintf(ctx->header, MAX_HEADER_LEN, vcd_header, "TODO: Date",
-                    PACKAGE_STRING, comment, 1, "ns", PACKAGE, (char *)&wbuf);
-       /* TODO: Handle snprintf() errors. */
+       g_string_append(ctx->header, "$upscope $end\n"
+                       "$enddefinitions $end\n$dumpvars\n");
 
        if (!(ctx->prevbits = calloc(sizeof(int), num_probes))) {
-               free(ctx->header);
+               g_string_free(ctx->header, TRUE);
                free(ctx);
-               return SIGROK_ERR_MALLOC;
+               return SR_ERR_MALLOC;
        }
 
-       return SIGROK_OK;
+       return SR_OK;
 }
 
-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;
 
        ctx = o->internal;
        switch (event_type) {
-       case DF_TRIGGER:
-               /* TODO */
-               break;
-       case DF_END:
-               outlen = strlen("$dumpoff\n$end\n");
-               if (!(outbuf = malloc(outlen + 1)))
-                       return SIGROK_ERR_MALLOC;
-               /* TODO: Bug? Drop the + 1? */
-               /* TODO: Handle snprintf() errors. */
-               snprintf(outbuf, outlen + 1, "$dumpoff\n$end\n");
+       case SR_DF_END:
+               outbuf = strdup("$dumpoff\n$end\n");
                *data_out = outbuf;
-               *length_out = outlen;
+               *length_out = strlen(outbuf);
                free(o->internal);
                o->internal = NULL;
                break;
+       default:
+               *data_out = NULL;
+               *length_out = 0;
+               break;
        }
 
-       return SIGROK_OK;
+       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;
+       unsigned int i;
        int p, curbit, prevbit;
-       uint64_t sample, prevsample;
-       char *outbuf, *c;
+       uint64_t sample;
+       static uint64_t samplecount = 0;
+       GString *out;
+       int first_sample = 0;
 
        ctx = o->internal;
-       outsize = 0;
-       if (ctx->header)
-               outsize = strlen(ctx->header);
-
-       /* FIXME: Use realloc(). */
-       if (!(outbuf = calloc(1, outsize + 1 + 10000)))
-               return SIGROK_ERR_MALLOC; /* TODO: free()? What to free? */
+       out = g_string_sized_new(512);
 
-       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);
+               g_string_append(out, ctx->header->str);
+               g_string_free(ctx->header, TRUE);
                ctx->header = NULL;
+               first_sample = 1;
        }
 
-       /* TODO: Are disabled probes handled correctly? */
-
        for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
+               samplecount++;
+
                memcpy(&sample, data_in + i, ctx->unitsize);
+
+               if (first_sample) {
+                       /* First packet. We neg to make sure sample is stored. */
+                       ctx->prevsample = ~sample;
+                       first_sample = 0;
+               }
+
                for (p = 0; p < ctx->num_enabled_probes; p++) {
-                       curbit = (sample & ((uint64_t) (1 << p))) != 0;
-                       if (i == 0) {
-                               prevbit = ~curbit;
-                       } else {
-                               memcpy(&prevsample, data_in + i - 1,
-                                      ctx->unitsize);
-                               prevbit =
-                                   (prevsample & ((uint64_t) (1 << p))) != 0;
-                       }
-
-                       /* VCD only contains deltas/changes. */
+                       curbit = (sample & ((uint64_t) (1 << p))) >> p;
+                       prevbit = (ctx->prevsample & ((uint64_t) (1 << p))) >> p;
+
+                       /* VCD only contains deltas/changes of signals. */
                        if (prevbit == curbit)
                                continue;
 
-                       /* FIXME: Only once per sample? */
-                       /* TODO: Is 'i' correct here? */
-                       c = outbuf + strlen(outbuf);
-                       sprintf(c, "#%i\n%i%c\n", i, curbit, (char)('!' + p));
+                       /* Output which signal changed to which value. */
+                       g_string_append_printf(out, "#%" PRIu64 "\n%i%c\n",
+                                       (uint64_t)(((float)samplecount / ctx->samplerate)
+                                       * ctx->period), curbit, (char)('!' + p));
                }
 
-               /* TODO: Use realloc() if strlen(outbuf) is almost "full"... */
+               ctx->prevsample = sample;
        }
 
-       *data_out = outbuf;
-       *length_out = strlen(outbuf);
+       *data_out = out->str;
+       *length_out = out->len;
+       g_string_free(out, FALSE);
 
-       return SIGROK_OK;
+       return SR_OK;
 }
 
-struct output_format output_vcd = {
+struct sr_output_format output_vcd = {
        "vcd",
        "Value Change Dump (VCD)",
+       SR_DF_LOGIC,
        init,
        data,
        event,