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         unsigned int num_enabled_probes;
  29         unsigned 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%s\
  38 # Timescale: %d %s\n\
  39 # Column/probe assignment:\n\
  40 # Column 0: Sample counter (for internal gnuplot purposes)\n%s\n";
  41
  42 const char *gnuplot_header_comment = "\
  43 # Comment: Acquisition with %d/%d probes at %s\n";
  44
  45 static int init(struct output *o)
  46 {
  47 /* Maximum header length */
  48 #define MAX_HEADER_LEN 2048
  49
  50         struct context *ctx;
  51         struct probe *probe;
  52         GSList *l;
  53         uint64_t samplerate;
  54         unsigned int i;
  55         int b, num_probes;
  56         char *c, *samplerate_s;
  57         char wbuf[1000], comment[128];
  58         time_t t;
  59
  60         if (!(ctx = calloc(1, sizeof(struct context))))
  61                 return SIGROK_ERR_MALLOC;
  62
  63         o->internal = ctx;
  64         ctx->num_enabled_probes = 0;
  65         for (l = o->device->probes; l; l = l->next) {
  66                 probe = l->data;
  67                 if (probe->enabled)
  68                         ctx->probelist[ctx->num_enabled_probes++] = probe->name;
  69         }
  70
  71         ctx->probelist[ctx->num_enabled_probes] = 0;
  72         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
  73
  74         /* TODO: Allow for configuration via o->param. */
  75
  76         if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
  77                 free(ctx);
  78                 return SIGROK_ERR_MALLOC;
  79         }
  80
  81         num_probes = g_slist_length(o->device->probes);
  82         /* TODO: Handle num_probes == 0, too many probes, etc. */
  83
  84         comment[0] = '\0';
  85         if (o->device->plugin) {
  86                 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
  87                                 o->device->plugin_index, DI_CUR_SAMPLERATE));
  88                 if (!(samplerate_s = sigrok_samplerate_string(samplerate))) {
  89                         free(ctx->header);
  90                         free(ctx);
  91                         return SIGROK_ERR;
  92                 }
  93                 snprintf(comment, 127, gnuplot_header_comment,
  94                          ctx->num_enabled_probes, num_probes, samplerate_s);
  95                 free(samplerate_s);
  96         }
  97
  98         /* Columns / channels */
  99         wbuf[0] = '\0';
 100         for (i = 0; i < ctx->num_enabled_probes; i++) {
 101                 c = (char *)&wbuf + strlen((char *)&wbuf);
 102                 sprintf(c, "# Column %d: %s\n", i + 1, ctx->probelist[i]);
 103         }
 104
 105         /* TODO: date: File or signals? Make y/n configurable. */
 106         /* TODO: Timescale */
 107         t = time(NULL);
 108         b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
 109                      PACKAGE_STRING, ctime(&t), comment, 1, "ns",
 110                      (char *)&wbuf);
 111
 112         /* TODO: Handle snprintf errors. */
 113
 114         return 0;
 115 }
 116
 117 static int event(struct output *o, int event_type, char **data_out,
 118                  uint64_t *length_out)
 119 {
 120         struct context *ctx;
 121
 122         ctx = o->internal;
 123         switch (event_type) {
 124         case DF_TRIGGER:
 125                 /* TODO */
 126                 break;
 127         case DF_END:
 128                 *data_out = NULL;
 129                 *length_out = 0;
 130                 free(o->internal);
 131                 o->internal = NULL;
 132                 break;
 133         }
 134
 135         return SIGROK_OK;
 136 }
 137
 138 static int data(struct output *o, char *data_in, uint64_t length_in,
 139                 char **data_out, uint64_t *length_out)
 140 {
 141         struct context *ctx;
 142         unsigned int i, outsize, p, curbit;
 143         uint64_t sample, count = 0;
 144         char *outbuf, *c;
 145
 146         ctx = o->internal;
 147         outsize = 0;
 148         if (ctx->header)
 149                 outsize = strlen(ctx->header);
 150
 151         /* FIXME: Use realloc(). */
 152         if (!(outbuf = calloc(1, outsize + 1 + 1000000)))
 153                 return SIGROK_ERR_MALLOC; /* TODO: free()? What to free? */
 154
 155         outbuf[0] = '\0';
 156         if (ctx->header) {
 157                 /* The header is still here, this must be the first packet. */
 158                 strncpy(outbuf, ctx->header, outsize);
 159                 free(ctx->header);
 160                 ctx->header = NULL;
 161         }
 162
 163         /* TODO: Are disabled probes handled correctly? */
 164
 165         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 166                 memcpy(&sample, data_in + i, ctx->unitsize);
 167
 168                 /* The first column is a counter (needed for gnuplot). */
 169                 c = outbuf + strlen(outbuf);
 170                 sprintf(c, "%" PRIu64 "\t\t", count++);
 171
 172                 /* The next columns are the values of all channels. */
 173                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 174                         curbit = (sample & ((uint64_t) (1 << p))) != 0;
 175                         c = outbuf + strlen(outbuf);
 176                         sprintf(c, "%d ", curbit);
 177                 }
 178
 179                 c = outbuf + strlen(outbuf);
 180                 sprintf(c, "\n");
 181
 182                 /* TODO: realloc() if strlen(outbuf) is almost "full"... */
 183         }
 184
 185         *data_out = outbuf;
 186         *length_out = strlen(outbuf);
 187
 188         return SIGROK_OK;
 189 }
 190
 191 struct output_format output_gnuplot = {
 192         "gnuplot",
 193         "Gnuplot",
 194         init,
 195         data,
 196         event,
 197 };