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 "sigrok-internal.h"
  26 #include "config.h"
  27
  28 struct context {
  29         unsigned int num_enabled_probes;
  30         unsigned int unitsize;
  31         char *probelist[SR_MAX_NUM_PROBES + 1];
  32         char *header;
  33 };
  34
  35 #define MAX_HEADER_LEN \
  36         (1024 + (SR_MAX_NUM_PROBES * (SR_MAX_PROBENAME_LEN + 10)))
  37
  38 static const char *gnuplot_header = "\
  39 # Sample data in space-separated columns format usable by gnuplot\n\
  40 #\n\
  41 # Generated by: %s on %s%s\
  42 # Period: %s\n\
  43 #\n\
  44 # Column\tProbe\n\
  45 # -------------------------------------\
  46 ----------------------------------------\n\
  47 # 0\t\tSample counter (for internal gnuplot purposes)\n%s\n";
  48
  49 static const char *gnuplot_header_comment = "\
  50 # Comment: Acquisition with %d/%d probes at %s\n";
  51
  52 static int init(struct sr_output *o)
  53 {
  54         struct context *ctx;
  55         struct sr_probe *probe;
  56         GSList *l;
  57         uint64_t samplerate;
  58         unsigned int i;
  59         int b, num_probes;
  60         char *c, *frequency_s;
  61         char wbuf[1000], comment[128];
  62         time_t t;
  63
  64         if (!o) {
  65                 sr_warn("gnuplot out: %s: o was NULL", __func__);
  66                 return SR_ERR_ARG;
  67         }
  68
  69         if (!o->device) {
  70                 sr_warn("gnuplot out: %s: o->device was NULL", __func__);
  71                 return SR_ERR_ARG;
  72         }
  73
  74         if (!o->device->plugin) {
  75                 sr_warn("gnuplot out: %s: o->device->plugin was NULL",
  76                         __func__);
  77                 return SR_ERR_ARG;
  78         }
  79
  80         if (!(ctx = calloc(1, sizeof(struct context)))) {
  81                 sr_warn("gnuplot out: %s: ctx calloc failed", __func__);
  82                 return SR_ERR_MALLOC;
  83         }
  84
  85         if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
  86                 sr_warn("gnuplot out: %s: ctx->header calloc failed",
  87                         __func__);
  88                 free(ctx);
  89                 return SR_ERR_MALLOC;
  90         }
  91
  92         o->internal = ctx;
  93         ctx->num_enabled_probes = 0;
  94         for (l = o->device->probes; l; l = l->next) {
  95                 probe = l->data; /* TODO: Error checks. */
  96                 if (!probe->enabled)
  97                         continue;
  98                 ctx->probelist[ctx->num_enabled_probes++] = probe->name;
  99         }
 100         ctx->probelist[ctx->num_enabled_probes] = 0;
 101         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
 102
 103         num_probes = g_slist_length(o->device->probes);
 104         comment[0] = '\0';
 105         if (sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
 106                 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
 107                                 o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
 108                 if (!(frequency_s = sr_samplerate_string(samplerate))) {
 109                         sr_warn("gnuplot out: %s: sr_samplerate_string failed",
 110                                 __func__);
 111                         free(ctx->header);
 112                         free(ctx);
 113                         return SR_ERR;
 114                 }
 115                 snprintf(comment, 127, gnuplot_header_comment,
 116                         ctx->num_enabled_probes, num_probes, frequency_s);
 117                 free(frequency_s);
 118         }
 119
 120         /* Columns / channels */
 121         wbuf[0] = '\0';
 122         for (i = 0; i < ctx->num_enabled_probes; i++) {
 123                 c = (char *)&wbuf + strlen((char *)&wbuf);
 124                 sprintf(c, "# %d\t\t%s\n", i + 1, ctx->probelist[i]);
 125         }
 126
 127         if (!(frequency_s = sr_period_string(samplerate))) {
 128                 sr_warn("gnuplot out: %s: sr_period_string failed", __func__);
 129                 free(ctx->header);
 130                 free(ctx);
 131                 return SR_ERR;
 132         }
 133
 134         t = time(NULL);
 135         b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
 136                      PACKAGE_STRING, ctime(&t), comment, frequency_s,
 137                      (char *)&wbuf);
 138         free(frequency_s);
 139
 140         if (b < 0) {
 141                 sr_warn("gnuplot out: %s: sprintf failed", __func__);
 142                 free(ctx->header);
 143                 free(ctx);
 144                 return SR_ERR;
 145         }
 146
 147         return 0;
 148 }
 149
 150 static int event(struct sr_output *o, int event_type, char **data_out,
 151                  uint64_t *length_out)
 152 {
 153         struct context *ctx;
 154
 155         if (!o) {
 156                 sr_warn("gnuplot out: %s: o was NULL", __func__);
 157                 return SR_ERR_ARG;
 158         }
 159
 160         if (!data_out) {
 161                 sr_warn("gnuplot out: %s: data_out was NULL", __func__);
 162                 return SR_ERR_ARG;
 163         }
 164
 165         if (!length_out) {
 166                 sr_warn("gnuplot out: %s: length_out was NULL", __func__);
 167                 return SR_ERR_ARG;
 168         }
 169
 170         ctx = o->internal;
 171
 172         switch (event_type) {
 173         case SR_DF_TRIGGER:
 174                 /* TODO: Can a trigger mark be in a gnuplot data file? */
 175                 break;
 176         case SR_DF_END:
 177                 free(o->internal);
 178                 o->internal = NULL;
 179                 break;
 180         default:
 181                 sr_warn("gnuplot out: %s: unsupported event type: %d",
 182                         __func__, event_type);
 183                 break;
 184         }
 185
 186         *data_out = NULL;
 187         *length_out = 0;
 188
 189         return SR_OK;
 190 }
 191
 192 static int data(struct sr_output *o, const char *data_in, uint64_t length_in,
 193                 char **data_out, uint64_t *length_out)
 194 {
 195         struct context *ctx;
 196         unsigned int max_linelen, outsize, p, curbit, i;
 197         uint64_t sample;
 198         static uint64_t samplecount = 0, old_sample = 0;
 199         char *outbuf, *c;
 200
 201         if (!o) {
 202                 sr_warn("gnuplot out: %s: o was NULL", __func__);
 203                 return SR_ERR_ARG;
 204         }
 205
 206         if (!o->internal) {
 207                 sr_warn("gnuplot out: %s: o->internal was NULL", __func__);
 208                 return SR_ERR_ARG;
 209         }
 210
 211         if (!data_in) {
 212                 sr_warn("gnuplot out: %s: data_in was NULL", __func__);
 213                 return SR_ERR_ARG;
 214         }
 215
 216         if (!data_out) {
 217                 sr_warn("gnuplot out: %s: data_out was NULL", __func__);
 218                 return SR_ERR_ARG;
 219         }
 220
 221         if (!length_out) {
 222                 sr_warn("gnuplot out: %s: length_out was NULL", __func__);
 223                 return SR_ERR_ARG;
 224         }
 225
 226         ctx = o->internal;
 227         max_linelen = 16 + ctx->num_enabled_probes * 2;
 228         outsize = length_in / ctx->unitsize * max_linelen;
 229         if (ctx->header)
 230                 outsize += strlen(ctx->header);
 231
 232         if (!(outbuf = calloc(1, outsize))) {
 233                 sr_warn("gnuplot out: %s: outbuf calloc failed", __func__);
 234                 return SR_ERR_MALLOC;
 235         }
 236
 237         outbuf[0] = '\0';
 238         if (ctx->header) {
 239                 /* The header is still here, this must be the first packet. */
 240                 strncpy(outbuf, ctx->header, outsize);
 241                 free(ctx->header);
 242                 ctx->header = NULL;
 243         }
 244
 245         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 246
 247                 memcpy(&sample, data_in + i, ctx->unitsize);
 248
 249                 /*
 250                  * Don't output the same samples multiple times. However, make
 251                  * sure to output at least the first and last sample.
 252                  */
 253                 if (samplecount++ != 0 && sample == old_sample) {
 254                         if (i != (length_in - ctx->unitsize))
 255                                 continue;
 256                 }
 257                 old_sample = sample;
 258
 259                 /* The first column is a counter (needed for gnuplot). */
 260                 c = outbuf + strlen(outbuf);
 261                 sprintf(c, "%" PRIu64 "\t", samplecount++);
 262
 263                 /* The next columns are the values of all channels. */
 264                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 265                         curbit = (sample & ((uint64_t) (1 << p))) >> p;
 266                         c = outbuf + strlen(outbuf);
 267                         sprintf(c, "%d ", curbit);
 268                 }
 269
 270                 c = outbuf + strlen(outbuf);
 271                 sprintf(c, "\n");
 272         }
 273
 274         *data_out = outbuf;
 275         *length_out = strlen(outbuf);
 276
 277         return SR_OK;
 278 }
 279
 280 struct sr_output_format output_gnuplot = {
 281         .id = "gnuplot",
 282         .description = "Gnuplot",
 283         .df_type = SR_DF_LOGIC,
 284         .init = init,
 285         .data = data,
 286         .event = event,
 287 };
 288
 289 /* Temporarily disabled. */
 290 #if 0
 291 static int analog_init(struct sr_output *o)
 292 {
 293         struct context *ctx;
 294         struct sr_probe *probe;
 295         GSList *l;
 296         uint64_t samplerate;
 297         unsigned int i;
 298         int b, num_probes;
 299         char *c, *frequency_s;
 300         char wbuf[1000], comment[128];
 301         time_t t;
 302
 303         if (!(ctx = calloc(1, sizeof(struct context))))
 304                 return SR_ERR_MALLOC;
 305
 306         if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
 307                 free(ctx);
 308                 return SR_ERR_MALLOC;
 309         }
 310
 311         o->internal = ctx;
 312         ctx->num_enabled_probes = 0;
 313         for (l = o->device->probes; l; l = l->next) {
 314                 probe = l->data;
 315                 if (!probe->enabled)
 316                         continue;
 317                 ctx->probelist[ctx->num_enabled_probes++] = probe->name;
 318         }
 319         ctx->probelist[ctx->num_enabled_probes] = 0;
 320 //      ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
 321         ctx->unitsize = sizeof(struct sr_analog_sample) +
 322                         (ctx->num_enabled_probes * sizeof(struct sr_analog_probe));
 323
 324         num_probes = g_slist_length(o->device->probes);
 325         comment[0] = '\0';
 326         if (o->device->plugin && sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
 327                 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
 328                                 o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
 329                 if (!(frequency_s = sr_samplerate_string(samplerate))) {
 330                         free(ctx->header);
 331                         free(ctx);
 332                         return SR_ERR;
 333                 }
 334                 snprintf(comment, 127, gnuplot_header_comment,
 335                         ctx->num_enabled_probes, num_probes, frequency_s);
 336                 free(frequency_s);
 337         }
 338
 339         /* Columns / channels */
 340         wbuf[0] = '\0';
 341         for (i = 0; i < ctx->num_enabled_probes; i++) {
 342                 c = (char *)&wbuf + strlen((char *)&wbuf);
 343                 sprintf(c, "# %d\t\t%s\n", i + 1, ctx->probelist[i]);
 344         }
 345
 346         if (!(frequency_s = sr_period_string(samplerate))) {
 347                 free(ctx->header);
 348                 free(ctx);
 349                 return SR_ERR;
 350         }
 351         t = time(NULL);
 352         b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
 353                      PACKAGE_STRING, ctime(&t), comment, frequency_s,
 354                      (char *)&wbuf);
 355         free(frequency_s);
 356
 357         if (b < 0) {
 358                 free(ctx->header);
 359                 free(ctx);
 360                 return SR_ERR;
 361         }
 362
 363         return 0;
 364 }
 365
 366 static int analog_data(struct sr_output *o, char *data_in, uint64_t length_in,
 367                 char **data_out, uint64_t *length_out)
 368 {
 369         struct context *ctx;
 370         unsigned int max_linelen, outsize, p, /* curbit, */ i;
 371 //      uint64_t sample;
 372         static uint64_t samplecount = 0;
 373         char *outbuf, *c;
 374         struct sr_analog_sample *sample;
 375
 376         ctx = o->internal;
 377 //      max_linelen = 16 + ctx->num_enabled_probes * 2;
 378         max_linelen = 16 + ctx->num_enabled_probes * 30;
 379         outsize = length_in / ctx->unitsize * max_linelen;
 380         if (ctx->header)
 381                 outsize += strlen(ctx->header);
 382
 383         if (!(outbuf = calloc(1, outsize)))
 384                 return SR_ERR_MALLOC;
 385
 386         outbuf[0] = '\0';
 387         if (ctx->header) {
 388                 /* The header is still here, this must be the first packet. */
 389                 strncpy(outbuf, ctx->header, outsize);
 390                 free(ctx->header);
 391                 ctx->header = NULL;
 392         }
 393
 394         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 395 //              memcpy(&sample, data_in + i, ctx->unitsize);
 396                 sample = (struct sr_analog_sample *) (data_in + i);
 397
 398                 /* The first column is a counter (needed for gnuplot). */
 399                 c = outbuf + strlen(outbuf);
 400                 sprintf(c, "%" PRIu64 "\t", samplecount++);
 401
 402                 /* The next columns are the values of all channels. */
 403                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 404 //                      curbit = (sample & ((uint64_t) (1 << p))) >> p;
 405                         c = outbuf + strlen(outbuf);
 406 //                      sprintf(c, "%d ", curbit);
 407                         /*
 408                          * FIXME: Should be doing proper raw->voltage conversion
 409                          * here, casting to int16_t isn't it. Remember that if
 410                          * res = 1 conversion isn't necessary.
 411                          */
 412                         sprintf(c, "%f ", (double) ((int16_t) (sample->probes[p].val &
 413                                         ((1 << sample->probes[p].res) - 1))));
 414                 }
 415
 416                 c = outbuf + strlen(outbuf);
 417                 sprintf(c, "\n");
 418         }
 419
 420         *data_out = outbuf;
 421         *length_out = strlen(outbuf);
 422
 423         return SR_OK;
 424 }
 425
 426 struct sr_output_format output_analog_gnuplot = {
 427         .id = "analog_gnuplot",
 428         .description = "Gnuplot analog",
 429         .df_type = SR_DF_ANALOG,
 430         .init = analog_init,
 431         .data = analog_data,
 432         .event = event,
 433 };
 434 #endif