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

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

diff --git a/src/output/hex.c b/src/output/hex.c
index 07a430ca6193044599a0a0b4cbb1637a6264651e..89111446c65001c503329796802582cf40be0d8e 100644 (file)
--- a/src/output/hex.c
+++ b/src/output/hex.c
@@ -17,10 +17,11 @@
  * 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"
@@ -29,7 +30,7 @@
 
 struct context {
        unsigned int num_enabled_channels;
-       int samples_per_line;
+       int spl;
        int bit_cnt;
        int spl_cnt;
        int trigger;
@@ -42,37 +43,20 @@ struct context {
        GString **lines;
 };
 
-static int init(struct sr_output *o)
+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;
-       int spl;
 
        if (!o || !o->sdi)
                return SR_ERR_ARG;
 
-       spl = DEFAULT_SAMPLES_PER_LINE;
-       g_hash_table_iter_init(&iter, o->params);
-       while (g_hash_table_iter_next(&iter, &key, &value)) {
-               if (!strcmp(key, "width")) {
-                       if ((spl = strtoul(value, NULL, 10)) < 1) {
-                               sr_err("Invalid width.");
-                               return SR_ERR_ARG;
-                       }
-               } else {
-                       sr_err("Unknown parameter '%s'.", key);
-                       return SR_ERR_ARG;
-               }
-       }
-
        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"));
 
        for (l = o->sdi->channels; l; l = l->next) {
                ch = l->data;
@@ -105,7 +89,7 @@ static int init(struct sr_output *o)
        return SR_OK;
 }
 
-static GString *gen_header(struct sr_output *o)
+static GString *gen_header(const struct sr_output *o)
 {
        struct context *ctx;
        GVariant *gvar;
@@ -113,7 +97,7 @@ static GString *gen_header(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) {
@@ -123,7 +107,7 @@ static GString *gen_header(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);
@@ -137,7 +121,7 @@ static GString *gen_header(struct sr_output *o)
        return header;
 }
 
-static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
                GString **out)
 {
        const struct sr_datafeed_meta *meta;
@@ -152,7 +136,7 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
        *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) {
@@ -192,19 +176,26 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
                                        ctx->sample_buf[j] = 0;
                                }
 
-                               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 2 hex digits plus
+                                                * 1 separator. Calculate the position of the byte
+                                                * which contains the trigger, then adjust for the
+                                                * trigger's bit position within that byte.
+                                                */
+                                               offset = ctx->trigger / 8 * (2 + 1);
+                                               offset += (ctx->trigger % 8) / 4;
                                                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;
                }
@@ -235,7 +226,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);
@@ -245,16 +236,34 @@ static int cleanup(struct sr_output *o)
                g_string_free(ctx->lines[i], TRUE);
        g_free(ctx->lines);
        g_free(ctx);
-       o->internal = NULL;
+       o->priv = NULL;
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_output_format output_hex = {
+static struct sr_option options[] = {
+       { "width", "Width", "Number of samples per line", NULL, NULL },
+       ALL_ZERO
+};
+
+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);
+       }
+
+       return options;
+}
+
+SR_PRIV struct sr_output_module output_hex = {
        .id = "hex",
-       .description = "Hexadecimal",
+       .name = "Hexadecimal",
+       .desc = "Hexadecimal digits logic data",
+       .exts = (const char*[]){"txt", NULL},
+       .flags = 0,
+       .options = get_options,
        .init = init,
        .receive = receive,
        .cleanup = cleanup,
 };
-