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