output/output_gnuplot.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <glib.h>
  24 #include <sigrok.h>
  25 #include "config.h"
  26
  27 struct context {
  28         int num_enabled_probes;
  29         int unitsize;
  30         char *probelist[65];
  31         char *header;
  32 };
  33
  34 const char *gnuplot_header = "\
  35 # Sample data in space-separated columns format usable by gnuplot\n\
  36 #\n\
  37 # Generated by: %s on %s\n\
  38 # Comment: Acquisition with %d/%d probes at %s\n\
  39 # Timescale: %d %s\n\
  40 # Column assignment:\n%s\n";
  41
  42 static int init(struct output *o)
  43 {
  44 /* Maximum header length */
  45 #define MAX_HEADER_LEN 2048
  46
  47         struct context *ctx;
  48         struct probe *probe;
  49         GSList *l;
  50         uint64_t samplerate;
  51         int i, b, num_probes;
  52         char *c;
  53         char sbuf[10], wbuf[1000];
  54
  55         ctx = malloc(sizeof(struct context));
  56         if (ctx == NULL)
  57                 return SIGROK_ERR_MALLOC;
  58         o->internal = ctx;
  59         ctx->num_enabled_probes = 0;
  60         for (l = o->device->probes; l; l = l->next) {
  61                 probe = l->data;
  62                 if (probe->enabled)
  63                         ctx->probelist[ctx->num_enabled_probes++] = probe->name;
  64         }
  65
  66         ctx->probelist[ctx->num_enabled_probes] = 0;
  67         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
  68
  69         /* TODO: Allow for configuration via o->param. */
  70
  71         ctx->header = calloc(1, MAX_HEADER_LEN + 1);
  72         if (ctx->header == NULL)
  73                 return SIGROK_ERR_MALLOC;
  74         num_probes = g_slist_length(o->device->probes);
  75         /* TODO: Handle num_probes == 0, too many probes, etc. */
  76         samplerate = *((uint64_t *) o->device->plugin->get_device_info(
  77                         o->device->plugin_index, DI_CUR_SAMPLERATE));
  78
  79         /* Samplerate string */
  80         if (samplerate >= GHZ(1))
  81                 snprintf(sbuf, 10, "%"PRIu64" GHz", samplerate / 1000000000);
  82         else if (samplerate >= MHZ(1))
  83                 snprintf(sbuf, 10, "%"PRIu64" MHz", samplerate / 1000000);
  84         else if (samplerate >= KHZ(1))
  85                 snprintf(sbuf, 10, "%"PRIu64" KHz", samplerate / 1000);
  86         else
  87                 snprintf(sbuf, 10, "%"PRIu64" Hz", samplerate);
  88
  89         /* Columns / channels */
  90         wbuf[0] = '\0';
  91         for (i = 0; i < ctx->num_enabled_probes; i++) {
  92                 c = (char *)&wbuf + strlen((char *)&wbuf);
  93                 sprintf(c, "# Column %d: channel %s\n", i, ctx->probelist[i]);
  94         }
  95
  96         /* TODO: date: File or signals? Make y/n configurable. */
  97         /* TODO: Timescale */
  98         b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
  99                      PACKAGE_STRING, "TODO", ctx->num_enabled_probes,
 100                      num_probes, (char *)&sbuf, 1, "ns", (char *)&wbuf);
 101
 102         /* TODO: Handle snprintf errors. */
 103
 104         return 0;
 105 }
 106
 107 static int event(struct output *o, int event_type, char **data_out,
 108                  uint64_t *length_out)
 109 {
 110         struct context *ctx;
 111         char *outbuf;
 112         int outlen = 1; /* FIXME */
 113
 114         ctx = o->internal;
 115         switch(event_type) {
 116         case DF_TRIGGER:
 117                 break;
 118         case DF_END:
 119                 outbuf = calloc(1, 1); // FIXME
 120                 if (outbuf == NULL)
 121                         return SIGROK_ERR_MALLOC;
 122                 *data_out = outbuf;
 123                 *length_out = outlen;
 124                 free(o->internal);
 125                 o->internal = NULL;
 126                 break;
 127         }
 128
 129         return SIGROK_OK;
 130 }
 131
 132 static int data(struct output *o, char *data_in, uint64_t length_in,
 133                 char **data_out, uint64_t *length_out)
 134 {
 135         struct context *ctx;
 136         int offset, outsize, p, curbit;
 137         uint64_t sample, count = 0;
 138         char *outbuf, *c;
 139
 140         ctx = o->internal;
 141         outsize = strlen(ctx->header);
 142         outbuf = calloc(1, outsize + 1 + 10000); // FIXME: Use realloc().
 143         if (outbuf == NULL)
 144                 return SIGROK_ERR_MALLOC;
 145         if (ctx->header) {
 146                 /* The header is still here, this must be the first packet. */
 147                 strncpy(outbuf, ctx->header, outsize);
 148                 free(ctx->header);
 149                 ctx->header = NULL;
 150         } else {
 151                 outbuf[0] = 0;
 152         }
 153
 154         /* TODO: Are disabled probes handled correctly? */
 155
 156         for (offset = 0; offset <= length_in - ctx->unitsize;
 157                                                 offset += ctx->unitsize) {
 158                 memcpy(&sample, data_in + offset, ctx->unitsize);
 159
 160                 /* The first column is a counter (needed for gnuplot). */
 161                 c = outbuf + strlen(outbuf);
 162                 sprintf(c, "%"PRIu64"\t\t", count++);
 163
 164                 /* The next columns are the values of all channels. */
 165                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 166                         curbit = (sample & ((uint64_t) (1 << p))) != 0;
 167                         c = outbuf + strlen(outbuf);
 168                         sprintf(c, "%d ", curbit);
 169                 }
 170
 171                 c = outbuf + strlen(outbuf);
 172                 sprintf(c, "\n");
 173
 174                 /* TODO: realloc() if strlen(outbuf) is almost "full"... */
 175         }
 176
 177         *data_out = outbuf;
 178         *length_out = strlen(outbuf);
 179
 180         return SIGROK_OK;
 181 }
 182
 183 struct output_format output_gnuplot = {
 184         "gnuplot",
 185         "Gnuplot",
 186         init,
 187         data,
 188         event,
 189 };