]> sigrok.org Git - libsigrok.git/blobdiff - output/csv.c
build: Portability fixes.
[libsigrok.git] / output / csv.c
index a671c292990d11ad35724651488e98392b637092..d17969e8279db59b83599b179e5c818193b1f0a9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
  *
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "output/csv: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+#define LOG_PREFIX "output/csv"
 
 struct context {
-       unsigned int num_enabled_probes;
-       unsigned int unitsize;
-       char *probelist[SR_MAX_NUM_PROBES + 1];
+       unsigned int num_enabled_channels;
        uint64_t samplerate;
-       GString *header;
        char separator;
+       gboolean header_done;
+       int *channel_index;
 };
 
 /*
@@ -51,180 +43,178 @@ struct context {
  *  - Option to (not) print samplenumber / time as extra column.
  *  - Option to "compress" output (only print changed samples, VCD-like).
  *  - Option to print comma-separated bits, or whole bytes/words (for 8/16
- *    probe LAs) as ASCII/hex etc. etc.
+ *    channel LAs) as ASCII/hex etc. etc.
  *  - Trigger support.
  */
 
 static int init(struct sr_output *o)
 {
        struct context *ctx;
-       struct sr_probe *probe;
+       struct sr_channel *ch;
        GSList *l;
-       int num_probes;
-       uint64_t *samplerate;
-       time_t t;
-       unsigned int i;
-
-       if (!o) {
-               sr_err("%s: o was NULL", __func__);
-               return SR_ERR_ARG;
-       }
+       int i;
 
-       if (!o->sdi) {
-               sr_err("%s: o->sdi was NULL", __func__);
+       if (!o || !o->sdi)
                return SR_ERR_ARG;
-       }
-
-       if (!o->sdi->driver) {
-               sr_err("%s: o->sdi->driver was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
-       if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
-               sr_err("%s: ctx malloc failed", __func__);
-               return SR_ERR_MALLOC;
-       }
 
+       ctx = g_malloc0(sizeof(struct context));
        o->internal = ctx;
+       ctx->separator = ',';
 
-       /* Get the number of probes, their names, and the unitsize. */
-       for (l = o->sdi->probes; l; l = l->next) {
-               probe = l->data;
-               if (!probe->enabled)
+       /* Get the number of channels, and the unitsize. */
+       for (l = o->sdi->channels; l; l = l->next) {
+               ch = l->data;
+               if (ch->type != SR_CHANNEL_LOGIC)
                        continue;
-               ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+               if (!ch->enabled)
+                       continue;
+               ctx->num_enabled_channels++;
        }
-       ctx->probelist[ctx->num_enabled_probes] = 0;
-       ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
+       ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
 
-       num_probes = g_slist_length(o->sdi->probes);
+       /* Once more to map the enabled channels. */
+       for (i = 0, l = o->sdi->channels; l; l = l->next) {
+               ch = l->data;
+               if (ch->type != SR_CHANNEL_LOGIC)
+                       continue;
+               if (!ch->enabled)
+                       continue;
+               ctx->channel_index[i++] = ch->index;
+       }
 
-       if (sr_dev_has_hwcap(o->sdi, SR_CONF_SAMPLERATE)) {
-               o->sdi->driver->config_get(SR_DI_CUR_SAMPLERATE,
-                               (const void **)&samplerate, o->sdi);
-               ctx->samplerate = *samplerate;
-       } else
-               ctx->samplerate = 0;
+       return SR_OK;
+}
 
-       ctx->separator = ',';
-       ctx->header = g_string_sized_new(512);
+static GString *gen_header(struct sr_output *o)
+{
+       struct context *ctx;
+       struct sr_channel *ch;
+       GVariant *gvar;
+       GString *header;
+       GSList *l;
+       time_t t;
+       int num_channels, i;
+       char *samplerate_s;
 
-       t = time(NULL);
+       ctx = o->internal;
+       header = g_string_sized_new(512);
 
        /* Some metadata */
-       g_string_append_printf(ctx->header, "; CSV, generated by %s on %s",
-                              PACKAGE_STRING, ctime(&t));
-       g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n",
-                              ctx->samplerate);
+       t = time(NULL);
+       g_string_append_printf(header, "; CSV, generated by %s on %s",
+                       PACKAGE_STRING, ctime(&t));
 
        /* Columns / channels */
-       g_string_append_printf(ctx->header, "; Channels (%d/%d): ",
-                              ctx->num_enabled_probes, num_probes);
-       for (i = 0; i < ctx->num_enabled_probes; i++)
-               g_string_append_printf(ctx->header, "%s, ", ctx->probelist[i]);
-       g_string_append_printf(ctx->header, "\n");
+       num_channels = g_slist_length(o->sdi->channels);
+       g_string_append_printf(header, "; Channels (%d/%d):",
+                       ctx->num_enabled_channels, num_channels);
+       for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
+               ch = l->data;
+               if (ch->type != SR_CHANNEL_LOGIC)
+                       continue;
+               if (!ch->enabled)
+                       continue;
+               g_string_append_printf(header, " %s,", ch->name);
+       }
+       if (o->sdi->channels)
+               /* Drop last separator. */
+               g_string_truncate(header, header->len - 1);
+       g_string_append_printf(header, "\n");
+
+       if (ctx->samplerate == 0) {
+               if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
+                               &gvar) == SR_OK) {
+                       ctx->samplerate = g_variant_get_uint64(gvar);
+                       g_variant_unref(gvar);
+               }
+       }
+       if (ctx->samplerate != 0) {
+               samplerate_s = sr_samplerate_string(ctx->samplerate);
+               g_string_append_printf(header, "; Samplerate: %s\n", samplerate_s);
+               g_free(samplerate_s);
+       }
 
-       return SR_OK;
+       return header;
 }
 
-static int event(struct sr_output *o, int event_type, uint8_t **data_out,
-                uint64_t *length_out)
+static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+               GString **out)
 {
+       const struct sr_datafeed_meta *meta;
+       const struct sr_datafeed_logic *logic;
+       const struct sr_config *src;
+       GSList *l;
        struct context *ctx;
+       int idx;
+       uint64_t i, j;
+       gchar *p, c;
 
-       if (!o) {
-               sr_err("%s: o was NULL", __func__);
+       *out = NULL;
+       if (!o || !o->sdi)
                return SR_ERR_ARG;
-       }
-
-       if (!(ctx = o->internal)) {
-               sr_err("%s: o->internal was NULL", __func__);
+       if (!(ctx = o->internal))
                return SR_ERR_ARG;
-       }
 
-       if (!data_out) {
-               sr_err("%s: data_out was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
-       switch (event_type) {
-       case SR_DF_TRIGGER:
-               sr_dbg("%s: SR_DF_TRIGGER event", __func__);
-               /* TODO */
-               *data_out = NULL;
-               *length_out = 0;
-               break;
-       case SR_DF_END:
-               sr_dbg("%s: SR_DF_END event", __func__);
-               /* TODO */
-               *data_out = NULL;
-               *length_out = 0;
-               g_free(o->internal);
-               o->internal = NULL;
+       switch (packet->type) {
+       case SR_DF_META:
+               meta = packet->payload;
+               for (l = meta->config; l; l = l->next) {
+                       src = l->data;
+                       if (src->key != SR_CONF_SAMPLERATE)
+                               continue;
+                       ctx->samplerate = g_variant_get_uint64(src->data);
+               }
                break;
-       default:
-               sr_err("%s: unsupported event type: %d", __func__, event_type);
-               *data_out = NULL;
-               *length_out = 0;
+       case SR_DF_LOGIC:
+               logic = packet->payload;
+               if (!ctx->header_done) {
+                       *out = gen_header(o);
+                       ctx->header_done = TRUE;
+               } else {
+                       *out = g_string_sized_new(512);
+               }
+
+               for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
+                       for (j = 0; j < ctx->num_enabled_channels; j++) {
+                               idx = ctx->channel_index[j];
+                               p = logic->data + i + idx / 8;
+                               c = *p & (1 << (idx % 8));
+                               g_string_append_c(*out, c ? '1' : '0');
+                               g_string_append_c(*out, ctx->separator);
+                       }
+                       if (j) {
+                               /* Drop last separator. */
+                               g_string_truncate(*out, (*out)->len - 1);
+                       }
+                       g_string_append_printf(*out, "\n");
+               }
                break;
        }
 
        return SR_OK;
 }
 
-static int data(struct sr_output *o, const uint8_t *data_in,
-               uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
+static int cleanup(struct sr_output *o)
 {
        struct context *ctx;
-       GString *outstr;
-       uint64_t sample, i;
-       int j;
-
-       if (!o) {
-               sr_err("%s: o was NULL", __func__);
-               return SR_ERR_ARG;
-       }
 
-       if (!(ctx = o->internal)) {
-               sr_err("%s: o->internal was NULL", __func__);
+       if (!o || !o->sdi)
                return SR_ERR_ARG;
-       }
 
-       if (!data_in) {
-               sr_err("%s: data_in was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
-       if (ctx->header) {
-               /* First data packet. */
-               outstr = ctx->header;
-               ctx->header = NULL;
-       } else {
-               outstr = g_string_sized_new(512);
-       }
-
-       for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
-               memcpy(&sample, data_in + i, ctx->unitsize);
-               for (j = ctx->num_enabled_probes - 1; j >= 0; j--) {
-                       g_string_append_printf(outstr, "%d%c",
-                               (int)((sample & (1 << j)) >> j),
-                               ctx->separator);
-               }
-               g_string_append_printf(outstr, "\n");
+       if (o->internal) {
+               ctx = o->internal;
+               g_free(ctx->channel_index);
+               g_free(o->internal);
+               o->internal = NULL;
        }
 
-       *data_out = (uint8_t *)outstr->str;
-       *length_out = outstr->len;
-       g_string_free(outstr, FALSE);
-
        return SR_OK;
 }
 
 SR_PRIV struct sr_output_format output_csv = {
        .id = "csv",
        .description = "Comma-separated values (CSV)",
-       .df_type = SR_DF_LOGIC,
        .init = init,
-       .data = data,
-       .event = event,
+       .receive = receive,
+       .cleanup = cleanup,
 };