output: fixup trigger marker position in ascii/bits/hex output modules

[libsigrok.git] / src / output / ascii.c

diff --git a/src/output/ascii.c b/src/output/ascii.c
index 9f69d0076040ba7269745984c1bf5e6caed6322e..3962fe9d80215fcde193e5556d78c3ab70f3ded1 100644 (file)
--- a/src/output/ascii.c
+++ b/src/output/ascii.c
@@ -18,16 +18,24 @@
  * 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 spl;
@@ -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)
@@ -58,6 +68,13 @@ static int init(struct sr_output *o, GHashTable *options)
        o->priv = ctx;
        ctx->trigger = -1;
        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;
@@ -107,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);
@@ -132,6 +149,7 @@ 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)
@@ -168,21 +186,26 @@ 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->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;
                                        }
@@ -227,6 +250,7 @@ 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->priv = NULL;
 
@@ -235,7 +259,8 @@ static int cleanup(struct sr_output *o)
 
 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 const struct sr_option *get_options(void)
@@ -243,6 +268,8 @@ static const struct sr_option *get_options(void)
        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;
@@ -251,11 +278,11 @@ static const struct sr_option *get_options(void)
 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,
 };
-
-