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_probe *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         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
  90
  91         num_probes = g_slist_length(o->sdi->probes);
  92         comment[0] = '\0';
  93         samplerate = 0;
  94         if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
  95                         &gvar) == SR_OK) {
  96                 samplerate = g_variant_get_uint64(gvar);
  97                 g_variant_unref(gvar);
  98                 if (!(frequency_s = sr_samplerate_string(samplerate))) {
  99                         sr_err("%s: sr_samplerate_string failed", __func__);
 100                         g_free(ctx);
 101                         return SR_ERR;
 102                 }
 103                 snprintf(comment, 127, gnuplot_header_comment,
 104                         ctx->num_enabled_probes, num_probes, frequency_s);
 105                 g_free(frequency_s);
 106         }
 107
 108         /* Columns / channels */
 109         wbuf[0] = '\0';
 110         for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
 111                 probe = l->data;
 112                 if (probe->type != SR_PROBE_LOGIC)
 113                         continue;
 114                 if (!probe->enabled)
 115                         continue;
 116                 c = (char *)&wbuf + strlen((const char *)&wbuf);
 117                 sprintf(c, "# %d\t\t%s\n", i + 1, probe->name);
 118         }
 119
 120         if (!(frequency_s = sr_period_string(samplerate))) {
 121                 sr_err("%s: sr_period_string failed", __func__);
 122                 g_free(ctx);
 123                 return SR_ERR;
 124         }
 125
 126         t = time(NULL);
 127         ctx->header = g_strdup_printf(gnuplot_header, PACKAGE_STRING,
 128                         ctime(&t), comment, frequency_s, (char *)&wbuf);
 129         g_free(frequency_s);
 130
 131         if (!(ctx->old_sample = g_try_malloc0(ctx->unitsize))) {
 132                 sr_err("%s: ctx->old_sample malloc failed", __func__);
 133                 g_free(ctx->header);
 134                 g_free(ctx);
 135                 return SR_ERR_MALLOC;
 136         }
 137
 138         return 0;
 139 }
 140
 141 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
 142                  uint64_t *length_out)
 143 {
 144         if (!o) {
 145                 sr_err("%s: o was NULL", __func__);
 146                 return SR_ERR_ARG;
 147         }
 148
 149         if (!data_out) {
 150                 sr_err("%s: data_out was NULL", __func__);
 151                 return SR_ERR_ARG;
 152         }
 153
 154         if (!length_out) {
 155                 sr_err("%s: length_out was NULL", __func__);
 156                 return SR_ERR_ARG;
 157         }
 158
 159         switch (event_type) {
 160         case SR_DF_TRIGGER:
 161                 /* TODO: Can a trigger mark be in a gnuplot data file? */
 162                 break;
 163         case SR_DF_END:
 164                 g_free(o->internal);
 165                 o->internal = NULL;
 166                 break;
 167         default:
 168                 sr_err("%s: unsupported event type: %d", __func__, event_type);
 169                 break;
 170         }
 171
 172         *data_out = NULL;
 173         *length_out = 0;
 174
 175         return SR_OK;
 176 }
 177
 178 static int data(struct sr_output *o, const uint8_t *data_in,
 179                 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
 180 {
 181         struct context *ctx;
 182         unsigned int max_linelen, outsize, p, curbit, i;
 183         const uint8_t *sample;
 184         static uint64_t samplecount = 0;
 185         uint8_t *outbuf, *c;
 186
 187         if (!o) {
 188                 sr_err("%s: o was NULL", __func__);
 189                 return SR_ERR_ARG;
 190         }
 191
 192         if (!o->internal) {
 193                 sr_err("%s: o->internal was NULL", __func__);
 194                 return SR_ERR_ARG;
 195         }
 196
 197         if (!data_in) {
 198                 sr_err("%s: data_in was NULL", __func__);
 199                 return SR_ERR_ARG;
 200         }
 201
 202         if (!data_out) {
 203                 sr_err("%s: data_out was NULL", __func__);
 204                 return SR_ERR_ARG;
 205         }
 206
 207         if (!length_out) {
 208                 sr_err("%s: length_out was NULL", __func__);
 209                 return SR_ERR_ARG;
 210         }
 211
 212         ctx = o->internal;
 213         max_linelen = 16 + ctx->num_enabled_probes * 2;
 214         outsize = length_in / ctx->unitsize * max_linelen;
 215         if (ctx->header)
 216                 outsize += strlen(ctx->header);
 217
 218         if (!(outbuf = g_try_malloc0(outsize))) {
 219                 sr_err("%s: outbuf malloc failed", __func__);
 220                 return SR_ERR_MALLOC;
 221         }
 222
 223         outbuf[0] = '\0';
 224         if (ctx->header) {
 225                 /* The header is still here, this must be the first packet. */
 226                 strncpy((char *)outbuf, ctx->header, outsize);
 227                 g_free(ctx->header);
 228                 ctx->header = NULL;
 229         }
 230
 231         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 232
 233                 sample = data_in + i;
 234
 235                 /*
 236                  * Don't output the same samples multiple times. However, make
 237                  * sure to output at least the first and last sample.
 238                  */
 239                 if (samplecount++ != 0 &&
 240                                 !memcmp(sample, ctx->old_sample, ctx->unitsize)) {
 241                         if (i != (length_in - ctx->unitsize))
 242                                 continue;
 243                 }
 244                 memcpy(ctx->old_sample, sample, ctx->unitsize);
 245
 246                 /* The first column is a counter (needed for gnuplot). */
 247                 c = outbuf + strlen((const char *)outbuf);
 248                 sprintf((char *)c, "%" PRIu64 "\t", samplecount++);
 249
 250                 /* The next columns are the values of all channels. */
 251                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 252                         curbit = (sample[p / 8] & ((uint8_t) (1 << (p % 8)))) >> (p % 8);
 253                         c = outbuf + strlen((const char *)outbuf);
 254                         sprintf((char *)c, "%d ", curbit);
 255                 }
 256
 257                 c = outbuf + strlen((const char *)outbuf);
 258                 sprintf((char *)c, "\n");
 259         }
 260
 261         *data_out = outbuf;
 262         *length_out = strlen((const char *)outbuf);
 263
 264         return SR_OK;
 265 }
 266
 267 SR_PRIV struct sr_output_format output_gnuplot = {
 268         .id = "gnuplot",
 269         .description = "Gnuplot",
 270         .df_type = SR_DF_LOGIC,
 271         .init = init,
 272         .data = data,
 273         .event = event,
 274 };