src/output/ascii.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011 Håvard Espeland <gus@ping.uio.no>
   5  * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <glib.h>
  25 #include <libsigrok/libsigrok.h>
  26 #include "libsigrok-internal.h"
  27
  28 #define LOG_PREFIX "output/hex"
  29
  30 #define DEFAULT_SAMPLES_PER_LINE 74
  31
  32 /*
  33  * The string looks ugly with escape characters, here is the readable
  34  * version: Use . and " for low and high bits, use \ and / to draw
  35  * falling and rising edges respectively.
  36  */
  37 #define DEFAULT_ASCII_CHARS ".\"\\/"
  38
  39 struct context {
  40         unsigned int num_enabled_channels;
  41         int spl;
  42         int spl_cnt;
  43         int trigger;
  44         uint64_t samplerate;
  45         int *channel_index;
  46         char **aligned_names;
  47         int max_namelen;
  48         char **line_values;
  49         uint8_t *prev_sample;
  50         gboolean header_done;
  51         GString **lines;
  52         GString *header;
  53         const char *charset;
  54         gboolean edges;
  55 };
  56
  57 static int init(struct sr_output *o, GHashTable *options)
  58 {
  59         struct context *ctx;
  60         struct sr_channel *ch;
  61         GSList *l;
  62         unsigned int j, max_namelen, alloc_line_len;
  63
  64         if (!o || !o->sdi)
  65                 return SR_ERR_ARG;
  66
  67         ctx = g_malloc0(sizeof(struct context));
  68         o->priv = ctx;
  69         ctx->trigger = -1;
  70         ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));
  71         ctx->charset = g_strdup(g_variant_get_string(
  72                 g_hash_table_lookup(options, "charset"), NULL));
  73         if (!ctx->charset || strlen(ctx->charset) < 2) {
  74                 g_free((gpointer)ctx->charset);
  75                 ctx->charset = g_strdup(DEFAULT_ASCII_CHARS);
  76         }
  77         ctx->edges = (strlen(ctx->charset) >= 4) ? TRUE : FALSE;
  78
  79         for (l = o->sdi->channels; l; l = l->next) {
  80                 ch = l->data;
  81                 if (ch->type != SR_CHANNEL_LOGIC)
  82                         continue;
  83                 if (!ch->enabled)
  84                         continue;
  85                 ctx->num_enabled_channels++;
  86         }
  87         ctx->channel_index = g_malloc0(sizeof(ctx->channel_index[0]) * ctx->num_enabled_channels);
  88         ctx->aligned_names = g_malloc0(sizeof(ctx->aligned_names[0]) * ctx->num_enabled_channels);
  89         ctx->lines = g_malloc0(sizeof(ctx->lines[0]) * ctx->num_enabled_channels);
  90         ctx->prev_sample = g_malloc0(g_slist_length(o->sdi->channels));
  91
  92         /* Get the maximum length across all active logic channels. */
  93         max_namelen = 0;
  94         for (l = o->sdi->channels; l; l = l->next) {
  95                 ch = l->data;
  96                 if (ch->type != SR_CHANNEL_LOGIC)
  97                         continue;
  98                 if (!ch->enabled)
  99                         continue;
 100                 max_namelen = MAX(max_namelen, strlen(ch->name));
 101         }
 102         ctx->max_namelen = max_namelen;
 103
 104         alloc_line_len = ctx->max_namelen + 8 + ctx->spl;
 105         j = 0;
 106         for (l = o->sdi->channels; l; l = l->next) {
 107                 ch = l->data;
 108                 if (ch->type != SR_CHANNEL_LOGIC)
 109                         continue;
 110                 if (!ch->enabled)
 111                         continue;
 112
 113                 ctx->channel_index[j] = ch->index;
 114                 ctx->aligned_names[j] = g_strdup_printf("%*s", max_namelen, ch->name);
 115
 116                 ctx->lines[j] = g_string_sized_new(alloc_line_len);
 117                 g_string_printf(ctx->lines[j], "%s:", ctx->aligned_names[j]);
 118
 119                 j++;
 120         }
 121
 122         return SR_OK;
 123 }
 124
 125 static GString *gen_header(const struct sr_output *o)
 126 {
 127         struct context *ctx;
 128         GVariant *gvar;
 129         GString *header;
 130         int num_channels;
 131         char *samplerate_s;
 132
 133         ctx = o->priv;
 134         if (ctx->samplerate == 0) {
 135                 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
 136                                 &gvar) == SR_OK) {
 137                         ctx->samplerate = g_variant_get_uint64(gvar);
 138                         g_variant_unref(gvar);
 139                 }
 140         }
 141
 142         header = g_string_sized_new(512);
 143         g_string_printf(header, "%s %s\n", PACKAGE_NAME, sr_package_version_string_get());
 144         num_channels = g_slist_length(o->sdi->channels);
 145         g_string_append_printf(header, "Acquisition with %d/%d channels",
 146                         ctx->num_enabled_channels, num_channels);
 147         if (ctx->samplerate != 0) {
 148                 samplerate_s = sr_samplerate_string(ctx->samplerate);
 149                 g_string_append_printf(header, " at %s", samplerate_s);
 150                 g_free(samplerate_s);
 151         }
 152         g_string_append_printf(header, "\n");
 153
 154         return header;
 155 }
 156
 157 static void maybe_add_trigger(struct context *ctx, GString *out)
 158 {
 159         int offset;
 160
 161         if (ctx->trigger <= -1)
 162                 return;
 163         offset = ctx->trigger;
 164         ctx->trigger = -1;
 165
 166         /*
 167          * Sample data lines have one character per bit and
 168          * no separator between bytes. Align trigger marker
 169          * to this layout.
 170          */
 171         g_string_append_printf(out, "%*s:%*s %d\n",
 172                 ctx->max_namelen, "T",
 173                 offset + 1, "^", offset);
 174 }
 175
 176
 177 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
 178                 GString **out)
 179 {
 180         const struct sr_datafeed_meta *meta;
 181         const struct sr_datafeed_logic *logic;
 182         const struct sr_config *src;
 183         GSList *l;
 184         struct context *ctx;
 185         int idx, curbit, prevbit;
 186         uint64_t i, j;
 187         gchar *p, c;
 188         size_t charidx;
 189
 190         *out = NULL;
 191         if (!o || !o->sdi)
 192                 return SR_ERR_ARG;
 193         if (!(ctx = o->priv))
 194                 return SR_ERR_ARG;
 195
 196         switch (packet->type) {
 197         case SR_DF_META:
 198                 meta = packet->payload;
 199                 for (l = meta->config; l; l = l->next) {
 200                         src = l->data;
 201                         if (src->key != SR_CONF_SAMPLERATE)
 202                                 continue;
 203                         ctx->samplerate = g_variant_get_uint64(src->data);
 204                 }
 205                 break;
 206         case SR_DF_TRIGGER:
 207                 ctx->trigger = ctx->spl_cnt;
 208                 break;
 209         case SR_DF_LOGIC:
 210                 if (!ctx->header_done) {
 211                         *out = gen_header(o);
 212                         ctx->header_done = TRUE;
 213                 } else {
 214                         *out = g_string_sized_new(512);
 215                 }
 216
 217                 logic = packet->payload;
 218                 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
 219                         ctx->spl_cnt++;
 220                         for (j = 0; j < ctx->num_enabled_channels; j++) {
 221                                 idx = ctx->channel_index[j];
 222                                 p = logic->data + i + idx / 8;
 223                                 curbit = *p & (1 << (idx % 8));
 224                                 prevbit = (ctx->prev_sample[idx / 8] & ((uint8_t) 1 << (idx % 8)));
 225
 226                                 charidx = curbit ? 1 : 0;
 227                                 if (ctx->edges && ctx->spl_cnt > 1) {
 228                                         if (curbit != prevbit)
 229                                                 charidx += 2;
 230                                 }
 231                                 c = ctx->charset[charidx];
 232                                 g_string_append_c(ctx->lines[j], c);
 233
 234                                 if (ctx->spl_cnt == ctx->spl) {
 235                                         /* Flush line buffers. */
 236                                         g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
 237                                         g_string_append_c(*out, '\n');
 238                                         if (j == ctx->num_enabled_channels - 1)
 239                                                 maybe_add_trigger(ctx, *out);
 240                                         g_string_printf(ctx->lines[j], "%s:", ctx->aligned_names[j]);
 241                                 }
 242                         }
 243                         if (ctx->spl_cnt == ctx->spl)
 244                                 /* Line buffers were already flushed. */
 245                                 ctx->spl_cnt = 0;
 246                         memcpy(ctx->prev_sample, logic->data + i, logic->unitsize);
 247                 }
 248                 break;
 249         case SR_DF_END:
 250                 if (ctx->spl_cnt) {
 251                         /* Line buffers need flushing. */
 252                         *out = g_string_sized_new(512);
 253                         for (i = 0; i < ctx->num_enabled_channels; i++) {
 254                                 g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
 255                                 g_string_append_c(*out, '\n');
 256                         }
 257                         maybe_add_trigger(ctx, *out);
 258                 }
 259                 break;
 260         }
 261
 262         return SR_OK;
 263 }
 264
 265 static int cleanup(struct sr_output *o)
 266 {
 267         struct context *ctx;
 268         unsigned int i;
 269
 270         if (!o)
 271                 return SR_ERR_ARG;
 272
 273         if (!(ctx = o->priv))
 274                 return SR_OK;
 275
 276         g_free(ctx->channel_index);
 277         g_free(ctx->prev_sample);
 278         for (i = 0; i < ctx->num_enabled_channels; i++) {
 279                 g_free(ctx->aligned_names[i]);
 280                 g_string_free(ctx->lines[i], TRUE);
 281         }
 282         g_free(ctx->aligned_names);
 283         g_free(ctx->lines);
 284         g_free((gpointer)ctx->charset);
 285         g_free(ctx);
 286         o->priv = NULL;
 287
 288         return SR_OK;
 289 }
 290
 291 static struct sr_option options[] = {
 292         { "width", "Width", "Number of samples per line", NULL, NULL },
 293         { "charset", "Charset", "Characters for 0/1 bits (and fall/rise edges)", NULL, NULL },
 294         ALL_ZERO
 295 };
 296
 297 static const struct sr_option *get_options(void)
 298 {
 299         if (!options[0].def) {
 300                 options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
 301                 g_variant_ref_sink(options[0].def);
 302                 options[1].def = g_variant_new_string(DEFAULT_ASCII_CHARS);
 303                 g_variant_ref_sink(options[1].def);
 304         }
 305
 306         return options;
 307 }
 308
 309 SR_PRIV struct sr_output_module output_ascii = {
 310         .id = "ascii",
 311         .name = "ASCII",
 312         .desc = "ASCII art logic data",
 313         .exts = (const char*[]){"txt", NULL},
 314         .flags = 0,
 315         .options = get_options,
 316         .init = init,
 317         .receive = receive,
 318         .cleanup = cleanup,
 319 };