]> sigrok.org Git - libsigrok.git/blobdiff - src/output/ascii.c
output: fixup trigger marker position in ascii/bits/hex output modules
[libsigrok.git] / src / output / ascii.c
index 72eb6822c58bc70278e18762b911cf06c860c503..3962fe9d80215fcde193e5556d78c3ab70f3ded1 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "output/hex"
 
 #define DEFAULT_SAMPLES_PER_LINE 74
 
+/*
+ * The string looks ugly with escape characters, here is the readable
+ * version: Use . and " for low and high bits, use \ and / to draw
+ * falling and rising edges respectively.
+ */
+#define DEFAULT_ASCII_CHARS ".\"\\/"
+
 struct context {
        unsigned int num_enabled_channels;
-       int samples_per_line;
+       int spl;
        int bit_cnt;
        int spl_cnt;
        int trigger;
@@ -42,6 +50,8 @@ struct context {
        gboolean header_done;
        GString **lines;
        GString *header;
+       const char *charset;
+       gboolean edges;
 };
 
 static int init(struct sr_output *o, GHashTable *options)
@@ -49,37 +59,22 @@ static int init(struct sr_output *o, GHashTable *options)
        struct context *ctx;
        struct sr_channel *ch;
        GSList *l;
-       GHashTableIter iter;
-       gpointer key, value;
        unsigned int i, j;
-       uint32_t spl;
 
        if (!o || !o->sdi)
                return SR_ERR_ARG;
 
-       spl = DEFAULT_SAMPLES_PER_LINE;
-       if (options) {
-               g_hash_table_iter_init(&iter, options);
-               while (g_hash_table_iter_next(&iter, &key, &value)) {
-                       if (!strcmp(key, "width")) {
-                               if (!g_variant_is_of_type(value, G_VARIANT_TYPE_UINT32)) {
-                                       sr_err("Invalid type for 'width' option.");
-                                       return SR_ERR_ARG;
-                               }
-                               if (!(spl = g_variant_get_uint32(value))) {
-                                       sr_err("Invalid width.");
-                                       return SR_ERR_ARG;
-                               }
-                       } else {
-                               sr_err("Unknown option '%s'.", key);
-                       }
-               }
-       }
-
        ctx = g_malloc0(sizeof(struct context));
-       o->internal = ctx;
+       o->priv = ctx;
        ctx->trigger = -1;
-       ctx->samples_per_line = spl;
+       ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));
+       ctx->charset = g_strdup(g_variant_get_string(
+               g_hash_table_lookup(options, "charset"), NULL));
+       if (!ctx->charset || strlen(ctx->charset) < 2) {
+               g_free((gpointer)ctx->charset);
+               ctx->charset = g_strdup(DEFAULT_ASCII_CHARS);
+       }
+       ctx->edges = (strlen(ctx->charset) >= 4) ? TRUE : FALSE;
 
        for (l = o->sdi->channels; l; l = l->next) {
                ch = l->data;
@@ -119,7 +114,7 @@ static GString *gen_header(const struct sr_output *o)
        int num_channels;
        char *samplerate_s;
 
-       ctx = o->internal;
+       ctx = o->priv;
        if (ctx->samplerate == 0) {
                if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
                                &gvar) == SR_OK) {
@@ -129,7 +124,7 @@ static GString *gen_header(const struct sr_output *o)
        }
 
        header = g_string_sized_new(512);
-       g_string_printf(header, "%s\n", PACKAGE_STRING);
+       g_string_printf(header, "%s %s\n", PACKAGE_NAME, SR_PACKAGE_VERSION_STRING);
        num_channels = g_slist_length(o->sdi->channels);
        g_string_append_printf(header, "Acquisition with %d/%d channels",
                        ctx->num_enabled_channels, num_channels);
@@ -154,11 +149,12 @@ static int receive(const struct sr_output *o, const struct sr_datafeed_packet *p
        int idx, offset, curbit, prevbit;
        uint64_t i, j;
        gchar *p, c;
+       size_t charidx;
 
        *out = NULL;
        if (!o || !o->sdi)
                return SR_ERR_ARG;
-       if (!(ctx = o->internal))
+       if (!(ctx = o->priv))
                return SR_ERR_ARG;
 
        switch (packet->type) {
@@ -190,28 +186,33 @@ static int receive(const struct sr_output *o, const struct sr_datafeed_packet *p
                                curbit = *p & (1 << (idx % 8));
                                prevbit = (ctx->prev_sample[idx / 8] & ((uint8_t) 1 << (idx % 8)));
 
-                               c = curbit ? '"' : '.';
-                               if (ctx->spl_cnt > 1) {
-                                       if (curbit < prevbit)
-                                               c = '\\';
-                                       else if (curbit > prevbit)
-                                               c = '/';
+                               charidx = curbit ? 1 : 0;
+                               if (ctx->edges && ctx->spl_cnt > 1) {
+                                       if (curbit != prevbit)
+                                               charidx += 2;
                                }
+                               c = ctx->charset[charidx];
                                g_string_append_c(ctx->lines[j], c);
 
-                               if (ctx->spl_cnt == ctx->samples_per_line) {
+                               if (ctx->spl_cnt == ctx->spl) {
                                        /* Flush line buffers. */
                                        g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
                                        g_string_append_c(*out, '\n');
-                                       if (j == ctx->num_enabled_channels  - 1 && ctx->trigger > -1) {
-                                               offset = ctx->trigger + ctx->trigger / 8;
+                                       if (j == ctx->num_enabled_channels - 1 && ctx->trigger > -1) {
+                                               /*
+                                                * Each group of 8 bits occupies 8 bit positions
+                                                * and no separator. With this dense presentation
+                                                * the "calculation" of the trigger position is
+                                                * rather straight forward.
+                                                */
+                                               offset = ctx->trigger;
                                                g_string_append_printf(*out, "T:%*s^ %d\n", offset, "", ctx->trigger);
                                                ctx->trigger = -1;
                                        }
                                        g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
                                }
                        }
-                       if (ctx->spl_cnt == ctx->samples_per_line)
+                       if (ctx->spl_cnt == ctx->spl)
                                /* Line buffers were already flushed. */
                                ctx->spl_cnt = 0;
                        memcpy(ctx->prev_sample, logic->data + i, logic->unitsize);
@@ -240,7 +241,7 @@ static int cleanup(struct sr_output *o)
        if (!o)
                return SR_ERR_ARG;
 
-       if (!(ctx = o->internal))
+       if (!(ctx = o->priv))
                return SR_OK;
 
        g_free(ctx->channel_index);
@@ -249,24 +250,27 @@ static int cleanup(struct sr_output *o)
        for (i = 0; i < ctx->num_enabled_channels; i++)
                g_string_free(ctx->lines[i], TRUE);
        g_free(ctx->lines);
+       g_free((gpointer)ctx->charset);
        g_free(ctx);
-       o->internal = NULL;
+       o->priv = NULL;
 
        return SR_OK;
 }
 
 static struct sr_option options[] = {
        { "width", "Width", "Number of samples per line", NULL, NULL },
-       { 0 }
+       { "charset", "Charset", "Characters for 0/1 bits (and fall/rise edges)", NULL, NULL },
+       ALL_ZERO
 };
 
-static struct sr_option *get_options(gboolean cached)
+static const struct sr_option *get_options(void)
 {
-       if (cached)
-               return options;
-
-       options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
-       g_variant_ref_sink(options[0].def);
+       if (!options[0].def) {
+               options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
+               g_variant_ref_sink(options[0].def);
+               options[1].def = g_variant_new_string(DEFAULT_ASCII_CHARS);
+               g_variant_ref_sink(options[1].def);
+       }
 
        return options;
 }
@@ -274,11 +278,11 @@ static struct sr_option *get_options(gboolean cached)
 SR_PRIV struct sr_output_module output_ascii = {
        .id = "ascii",
        .name = "ASCII",
-       .desc = "ASCII art",
+       .desc = "ASCII art logic data",
+       .exts = (const char*[]){"txt", NULL},
+       .flags = 0,
        .options = get_options,
        .init = init,
        .receive = receive,
        .cleanup = cleanup,
 };
-
-