output/gnuplot.c

   1 /*
   2  * This file is part of the libsigrok 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 "config.h" /* Needed for PACKAGE_STRING and others. */
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27
  28 #define LOG_PREFIX "output/gnuplot"
  29
  30 struct context {
  31         unsigned int num_enabled_probes;
  32         unsigned int unitsize;
  33         char *header;
  34         uint8_t *old_sample;
  35 };
  36
  37 static const char *gnuplot_header = "\
  38 # Sample data in space-separated columns format usable by gnuplot\n\
  39 #\n\
  40 # Generated by: %s on %s%s\
  41 # Period: %s\n\
  42 #\n\
  43 # Column\tProbe\n\
  44 # -------------------------------------\
  45 ----------------------------------------\n\
  46 # 0\t\tSample counter (for internal gnuplot purposes)\n%s\n";
  47
  48 static const char *gnuplot_header_comment = "\
  49 # Comment: Acquisition with %d/%d probes at %s\n";
  50
  51 static int init(struct sr_output *o)
  52 {
  53         struct context *ctx;
  54         struct sr_channel *probe;
  55         GSList *l;
  56         GVariant *gvar;
  57         uint64_t samplerate;
  58         unsigned int i;
  59         int num_probes;
  60         char *c, *frequency_s;
  61         char wbuf[1000], comment[128];
  62         time_t t;
  63
  64         if (!o) {
  65                 sr_err("%s: o was NULL", __func__);
  66                 return SR_ERR_ARG;
  67         }
  68
  69         if (!o->sdi) {
  70                 sr_err("%s: o->sdi was NULL", __func__);
  71                 return SR_ERR_ARG;
  72         }
  73
  74         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
  75                 sr_err("%s: ctx malloc failed", __func__);
  76                 return SR_ERR_MALLOC;
  77         }
  78
  79         o->internal = ctx;
  80         ctx->num_enabled_probes = 0;
  81         for (l = o->sdi->probes; l; l = l->next) {
  82                 probe = l->data;
  83                 if (probe->type != SR_PROBE_LOGIC)
  84                         continue;
  85                 if (!probe->enabled)
  86                         continue;
  87                 ctx->num_enabled_probes++;
  88         }
  89         if (ctx->num_enabled_probes <= 0) {
  90                 sr_err("%s: no logic probe enabled", __func__);
  91                 return SR_ERR;
  92         }
  93
  94         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
  95
  96         num_probes = g_slist_length(o->sdi->probes);
  97         comment[0] = '\0';
  98         samplerate = 0;
  99         if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
 100                         &gvar) == SR_OK) {
 101                 samplerate = g_variant_get_uint64(gvar);
 102                 g_variant_unref(gvar);
 103                 if (!(frequency_s = sr_samplerate_string(samplerate))) {
 104                         sr_err("%s: sr_samplerate_string failed", __func__);
 105                         g_free(ctx);
 106                         return SR_ERR;
 107                 }
 108                 snprintf(comment, 127, gnuplot_header_comment,
 109                         ctx->num_enabled_probes, num_probes, frequency_s);
 110                 g_free(frequency_s);
 111         }
 112
 113         /* Columns / channels */
 114         wbuf[0] = '\0';
 115         for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
 116                 probe = l->data;
 117                 if (probe->type != SR_PROBE_LOGIC)
 118                         continue;
 119                 if (!probe->enabled)
 120                         continue;
 121                 c = (char *)&wbuf + strlen((const char *)&wbuf);
 122                 sprintf(c, "# %d\t\t%s\n", i + 1, probe->name);
 123         }
 124
 125         if (!(frequency_s = sr_period_string(samplerate))) {
 126                 sr_err("%s: sr_period_string failed", __func__);
 127                 g_free(ctx);
 128                 return SR_ERR;
 129         }
 130
 131         t = time(NULL);
 132         ctx->header = g_strdup_printf(gnuplot_header, PACKAGE_STRING,
 133                         ctime(&t), comment, frequency_s, (char *)&wbuf);
 134         g_free(frequency_s);
 135
 136         if (!(ctx->old_sample = g_try_malloc0(ctx->unitsize))) {
 137                 sr_err("%s: ctx->old_sample malloc failed", __func__);
 138                 g_free(ctx->header);
 139                 g_free(ctx);
 140                 return SR_ERR_MALLOC;
 141         }
 142
 143         return 0;
 144 }
 145
 146 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
 147                  uint64_t *length_out)
 148 {
 149         if (!o) {
 150                 sr_err("%s: o was NULL", __func__);
 151                 return SR_ERR_ARG;
 152         }
 153
 154         if (!data_out) {
 155                 sr_err("%s: data_out was NULL", __func__);
 156                 return SR_ERR_ARG;
 157         }
 158
 159         if (!length_out) {
 160                 sr_err("%s: length_out was NULL", __func__);
 161                 return SR_ERR_ARG;
 162         }
 163
 164         switch (event_type) {
 165         case SR_DF_TRIGGER:
 166                 /* TODO: Can a trigger mark be in a gnuplot data file? */
 167                 break;
 168         case SR_DF_END:
 169                 g_free(o->internal);
 170                 o->internal = NULL;
 171                 break;
 172         default:
 173                 sr_err("%s: unsupported event type: %d", __func__, event_type);
 174                 break;
 175         }
 176
 177         *data_out = NULL;
 178         *length_out = 0;
 179
 180         return SR_OK;
 181 }
 182
 183 static int data(struct sr_output *o, const uint8_t *data_in,
 184                 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
 185 {
 186         struct context *ctx;
 187         unsigned int max_linelen, outsize, p, curbit, i;
 188         const uint8_t *sample;
 189         static uint64_t samplecount = 0;
 190         uint8_t *outbuf, *c;
 191
 192         if (!o) {
 193                 sr_err("%s: o was NULL", __func__);
 194                 return SR_ERR_ARG;
 195         }
 196
 197         if (!o->internal) {
 198                 sr_err("%s: o->internal was NULL", __func__);
 199                 return SR_ERR_ARG;
 200         }
 201
 202         if (!data_in) {
 203                 sr_err("%s: data_in was NULL", __func__);
 204                 return SR_ERR_ARG;
 205         }
 206
 207         if (!data_out) {
 208                 sr_err("%s: data_out was NULL", __func__);
 209                 return SR_ERR_ARG;
 210         }
 211
 212         if (!length_out) {
 213                 sr_err("%s: length_out was NULL", __func__);
 214                 return SR_ERR_ARG;
 215         }
 216
 217         ctx = o->internal;
 218         max_linelen = 16 + ctx->num_enabled_probes * 2;
 219         outsize = length_in / ctx->unitsize * max_linelen;
 220         if (ctx->header)
 221                 outsize += strlen(ctx->header);
 222
 223         if (!(outbuf = g_try_malloc0(outsize))) {
 224                 sr_err("%s: outbuf malloc failed", __func__);
 225                 return SR_ERR_MALLOC;
 226         }
 227
 228         outbuf[0] = '\0';
 229         if (ctx->header) {
 230                 /* The header is still here, this must be the first packet. */
 231                 strncpy((char *)outbuf, ctx->header, outsize);
 232                 g_free(ctx->header);
 233                 ctx->header = NULL;
 234         }
 235
 236         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 237
 238                 sample = data_in + i;
 239
 240                 /*
 241                  * Don't output the same samples multiple times. However, make
 242                  * sure to output at least the first and last sample.
 243                  */
 244                 if (samplecount++ != 0 &&
 245                                 !memcmp(sample, ctx->old_sample, ctx->unitsize)) {
 246                         if (i != (length_in - ctx->unitsize))
 247                                 continue;
 248                 }
 249                 memcpy(ctx->old_sample, sample, ctx->unitsize);
 250
 251                 /* The first column is a counter (needed for gnuplot). */
 252                 c = outbuf + strlen((const char *)outbuf);
 253                 sprintf((char *)c, "%" PRIu64 "\t", samplecount++);
 254
 255                 /* The next columns are the values of all channels. */
 256                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 257                         curbit = (sample[p / 8] & ((uint8_t) (1 << (p % 8)))) >> (p % 8);
 258                         c = outbuf + strlen((const char *)outbuf);
 259                         sprintf((char *)c, "%d ", curbit);
 260                 }
 261
 262                 c = outbuf + strlen((const char *)outbuf);
 263                 sprintf((char *)c, "\n");
 264         }
 265
 266         *data_out = outbuf;
 267         *length_out = strlen((const char *)outbuf);
 268
 269         return SR_OK;
 270 }
 271
 272 SR_PRIV struct sr_output_format output_gnuplot = {
 273         .id = "gnuplot",
 274         .description = "Gnuplot",
 275         .df_type = SR_DF_LOGIC,
 276         .init = init,
 277         .data = data,
 278         .event = event,
 279 };