From: Marc Jacobi Date: Sun, 29 Sep 2019 07:07:47 +0000 (+0200) Subject: output/wavedrom: introduce a wavedrom output module X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=40f812f5dc38f3ac0698ea2e9adfab91032ffdfb;p=libsigrok.git output/wavedrom: introduce a wavedrom output module WaveDrom provides a textual description of digital timing diagrams, using the JSON syntax. See https://wavedrom.com/ for more details. --- diff --git a/Makefile.am b/Makefile.am index cbb7da2f..b9594883 100644 --- a/Makefile.am +++ b/Makefile.am @@ -95,6 +95,7 @@ libsigrok_la_SOURCES += \ src/output/ols.c \ src/output/srzip.c \ src/output/vcd.c \ + src/output/wavedrom.c \ src/output/null.c # Transform modules diff --git a/src/output/output.c b/src/output/output.c index c6c2d720..1a134eb2 100644 --- a/src/output/output.c +++ b/src/output/output.c @@ -64,6 +64,7 @@ extern SR_PRIV struct sr_output_module output_csv; extern SR_PRIV struct sr_output_module output_analog; extern SR_PRIV struct sr_output_module output_srzip; extern SR_PRIV struct sr_output_module output_wav; +extern SR_PRIV struct sr_output_module output_wavedrom; extern SR_PRIV struct sr_output_module output_null; /* @endcond */ @@ -79,6 +80,7 @@ static const struct sr_output_module *output_module_list[] = { &output_analog, &output_srzip, &output_wav, + &output_wavedrom, &output_null, NULL, }; diff --git a/src/output/wavedrom.c b/src/output/wavedrom.c new file mode 100644 index 00000000..47671729 --- /dev/null +++ b/src/output/wavedrom.c @@ -0,0 +1,195 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2019 Marc Jacobi + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include +#include "libsigrok-internal.h" + +#define LOG_PREFIX "output/wavedrom" + +struct context +{ + uint32_t channel_count; + // TODO: remove this, channels are available with each call + struct sr_channel **channels; + + // output strings + GString **channel_outputs; +}; + +// takes all data collected in context and +// renders it all to a JSON string. +static GString *wavedrom_render(const struct context *ctx) +{ + // open + GString *output = g_string_new("{ \"signal\": ["); + uint32_t ch, i; + char lastChar, currentChar; + + for (ch = 0; ch < ctx->channel_count; ch++) { + if (!ctx->channel_outputs[ch]) + continue; + + // channel strip + g_string_append_printf(output, + "{ \"name\": \"%s\", \"wave\": \"", ctx->channels[ch]->name); + + lastChar = 0; + for (i = 0; i < ctx->channel_outputs[ch]->len; i++) { + currentChar = ctx->channel_outputs[ch]->str[i]; + // data point + if (currentChar == lastChar) { + g_string_append_c(output, '.'); + } else { + g_string_append_c(output, currentChar); + lastChar = currentChar; + } + } + if (ch < ctx->channel_count - 1) { + g_string_append(output, "\" },"); + } else { + // last channel - no comma + g_string_append(output, "\" }"); + } + } + + // close + g_string_append(output, "], \"config\": { \"skin\": \"narrow\" }}"); + return output; +} + +static int init(struct sr_output *o, GHashTable *options) +{ + struct context *ctx; + struct sr_channel *channel; + GSList *l; + uint32_t i; + + (void)options; + + if (!o || !o->sdi) + return SR_ERR_ARG; + + o->priv = ctx = g_malloc(sizeof(struct context)); + + ctx->channel_count = g_slist_length(o->sdi->channels); + ctx->channels = g_malloc( + sizeof(struct sr_channel) * ctx->channel_count); + ctx->channel_outputs = g_malloc( + sizeof(GString *) * ctx->channel_count); + + for (i = 0, l = o->sdi->channels; l; l = l->next, i++) { + channel = l->data; + if (channel->enabled && + channel->type == SR_CHANNEL_LOGIC) { + ctx->channels[i] = channel; + ctx->channel_outputs[i] = g_string_new(NULL); + } else { + ctx->channels[i] = NULL; + ctx->channel_outputs[i] = NULL; + } + } + + return SR_OK; +} + +static int cleanup(struct sr_output *o) +{ + struct context *ctx; + uint32_t i; + + if (!o) + return SR_ERR_ARG; + + ctx = o->priv; + o->priv = NULL; + + if (ctx) { + for (i = 0; i < ctx->channel_count; i++) { + if (ctx->channel_outputs[i]) + g_string_free(ctx->channel_outputs[i], TRUE); + } + g_free(ctx->channel_outputs); + g_free(ctx->channels); + g_free(ctx); + } + + return SR_OK; +} + +static void process_logic(const struct context *ctx, + const struct sr_datafeed_logic *logic) +{ + unsigned int sample_count, ch, i; + uint8_t *sample; + + sample_count = logic->length / logic->unitsize; + + // extract the logic bits for each channel and + // store them as wavedrom letters (1/0) in each channel's string + for (ch = 0; ch < ctx->channel_count; ch++) { + if (ctx->channels[ch]) { + for (i = 0; i < sample_count; i++) { + sample = logic->data + i * logic->unitsize; + + if (ctx->channel_outputs[ch]) { + g_string_append_c(ctx->channel_outputs[ch], + sample[ch / 8] & (1 << (ch % 8)) ? '1' : '0'); + } + } + } + } +} + +static int receive(const struct sr_output *o, + const struct sr_datafeed_packet *packet, GString **out) +{ + struct context *ctx; + + *out = NULL; + + if (!o || !o->sdi || !o->priv) + return SR_ERR_ARG; + + ctx = o->priv; + + switch (packet->type) { + case SR_DF_LOGIC: + process_logic(ctx, packet->payload); + break; + case SR_DF_END: + *out = wavedrom_render(ctx); + break; + } + + return SR_OK; +} + +SR_PRIV struct sr_output_module output_wavedrom = { + .id = "wavedrom", + .name = "WAVEDROM", + .desc = "WaveDrom.com file format", + .exts = (const char *[]){"wavedrom", "json", NULL}, + .flags = 0, + .options = NULL, + .init = init, + .receive = receive, + .cleanup = cleanup, +};