X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Foutput%2Fascii.c;h=ecab0fd152df4572edab424d7775eda1e978a36a;hb=HEAD;hp=d06894273338715d56db4a2bf66b336fb5e86ed8;hpb=155b680da482cea2381becb73c51cfb838bff31e;p=libsigrok.git

diff --git a/src/output/ascii.c b/src/output/ascii.c
index d0689427..ecab0fd1 100644
--- a/src/output/ascii.c
+++ b/src/output/ascii.c
@@ -18,63 +18,62 @@
  * 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 bit_cnt;
-	int spl_cnt;
+	size_t num_enabled_channels;
+	size_t spl;
+	size_t spl_cnt;
 	int trigger;
 	uint64_t samplerate;
 	int *channel_index;
-	char **channel_names;
+	char **aligned_names;
+	size_t max_namelen;
 	char **line_values;
 	uint8_t *prev_sample;
 	gboolean header_done;
 	GString **lines;
-	GString *header;
+	const char *charset;
+	gboolean edges;
 };
 
-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;
+	size_t j, max_namelen, alloc_line_len;
 
 	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"));
+	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;
@@ -84,37 +83,53 @@ static int init(struct sr_output *o)
 			continue;
 		ctx->num_enabled_channels++;
 	}
-	ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
-	ctx->channel_names = g_malloc(sizeof(char *) * ctx->num_enabled_channels);
-	ctx->lines = g_malloc(sizeof(GString *) * ctx->num_enabled_channels);
-	ctx->prev_sample = g_malloc(g_slist_length(o->sdi->channels));
+	ctx->channel_index = g_malloc0(sizeof(ctx->channel_index[0]) * ctx->num_enabled_channels);
+	ctx->aligned_names = g_malloc0(sizeof(ctx->aligned_names[0]) * ctx->num_enabled_channels);
+	ctx->lines = g_malloc0(sizeof(ctx->lines[0]) * ctx->num_enabled_channels);
+	ctx->prev_sample = g_malloc0(g_slist_length(o->sdi->channels));
 
+	/* Get the maximum length across all active logic channels. */
+	max_namelen = 0;
+	for (l = o->sdi->channels; l; l = l->next) {
+		ch = l->data;
+		if (ch->type != SR_CHANNEL_LOGIC)
+			continue;
+		if (!ch->enabled)
+			continue;
+		max_namelen = MAX(max_namelen, strlen(ch->name));
+	}
+	ctx->max_namelen = max_namelen;
+
+	alloc_line_len = ctx->max_namelen + 8 + ctx->spl;
 	j = 0;
-	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
+	for (l = o->sdi->channels; l; l = l->next) {
 		ch = l->data;
 		if (ch->type != SR_CHANNEL_LOGIC)
 			continue;
 		if (!ch->enabled)
 			continue;
+
 		ctx->channel_index[j] = ch->index;
-		ctx->channel_names[j] = ch->name;
-		ctx->lines[j] = g_string_sized_new(80);
-		g_string_printf(ctx->lines[j], "%s:", ch->name);
+		ctx->aligned_names[j] = g_strdup_printf("%*s", (int)max_namelen, ch->name);
+
+		ctx->lines[j] = g_string_sized_new(alloc_line_len);
+		g_string_printf(ctx->lines[j], "%s:", ctx->aligned_names[j]);
+
 		j++;
 	}
 
 	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;
 	GString *header;
-	int num_channels;
+	size_t 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) {
@@ -124,9 +139,9 @@ 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_get());
 	num_channels = g_slist_length(o->sdi->channels);
-	g_string_append_printf(header, "Acquisition with %d/%d channels",
+	g_string_append_printf(header, "Acquisition with %zu/%zu channels",
 			ctx->num_enabled_channels, num_channels);
 	if (ctx->samplerate != 0) {
 		samplerate_s = sr_samplerate_string(ctx->samplerate);
@@ -138,7 +153,26 @@ static GString *gen_header(struct sr_output *o)
 	return header;
 }
 
-static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+static void maybe_add_trigger(struct context *ctx, GString *out)
+{
+	int offset;
+
+	if (ctx->trigger < 0)
+		return;
+	offset = ctx->trigger;
+	ctx->trigger = -1;
+
+	/*
+	 * Sample data lines have one character per bit and
+	 * no separator between bytes. Align trigger marker
+	 * to this layout.
+	 */
+	g_string_append_printf(out, "%*s:%*s %d\n",
+		(int)ctx->max_namelen, "T",
+		offset + 1, "^", offset);
+}
+
+static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
 		GString **out)
 {
 	const struct sr_datafeed_meta *meta;
@@ -146,14 +180,18 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
 	const struct sr_config *src;
 	GSList *l;
 	struct context *ctx;
-	int idx, offset, curbit, prevbit;
-	uint64_t i, j;
-	gchar *p, c;
+	size_t idx, i, j;
+	size_t num_samples;
+	const uint8_t *curr_sample;
+	size_t bytepos;
+	uint8_t bitmask, curbit, prevbit;
+	char 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) {
@@ -173,43 +211,44 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
 		if (!ctx->header_done) {
 			*out = gen_header(o);
 			ctx->header_done = TRUE;
-		} else
+		} else {
 			*out = g_string_sized_new(512);
+		}
 
 		logic = packet->payload;
-		for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
+		num_samples = logic->length / logic->unitsize;
+		curr_sample = logic->data;
+		while (num_samples--) {
 			ctx->spl_cnt++;
 			for (j = 0; j < ctx->num_enabled_channels; j++) {
 				idx = ctx->channel_index[j];
-				p = logic->data + i + idx / 8;
-				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 = '/';
+				bytepos = idx / 8;
+				bitmask = 1U << (idx % 8);
+				curbit = curr_sample[bytepos] & bitmask;
+				prevbit = ctx->prev_sample[bytepos] & bitmask;
+
+				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;
-						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 (j + 1 == ctx->num_enabled_channels)
+						maybe_add_trigger(ctx, *out);
+					g_string_printf(ctx->lines[j], "%s:", ctx->aligned_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);
+			memcpy(ctx->prev_sample, curr_sample, logic->unitsize);
+			curr_sample += logic->unitsize;
 		}
 		break;
 	case SR_DF_END:
@@ -220,6 +259,7 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
 				g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
 				g_string_append_c(*out, '\n');
 			}
+			maybe_add_trigger(ctx, *out);
 		}
 		break;
 	}
@@ -230,32 +270,55 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
 static int cleanup(struct sr_output *o)
 {
 	struct context *ctx;
-	unsigned int i;
+	size_t i;
 
 	if (!o)
 		return SR_ERR_ARG;
 
-	if (!(ctx = o->internal))
+	if (!(ctx = o->priv))
 		return SR_OK;
 
 	g_free(ctx->channel_index);
 	g_free(ctx->prev_sample);
-	g_free(ctx->channel_names);
-	for (i = 0; i < ctx->num_enabled_channels; i++)
+	for (i = 0; i < ctx->num_enabled_channels; i++) {
+		g_free(ctx->aligned_names[i]);
 		g_string_free(ctx->lines[i], TRUE);
+	}
+	g_free(ctx->aligned_names);
 	g_free(ctx->lines);
+	g_free((gpointer)ctx->charset);
 	g_free(ctx);
-	o->internal = NULL;
+	o->priv = NULL;
 
 	return SR_OK;
 }
 
-SR_PRIV struct sr_output_format output_ascii = {
+static struct sr_option options[] = {
+	{ "width", "Width", "Number of samples per line", NULL, NULL },
+	{ "charset", "Charset", "Characters for 0/1 bits (and fall/rise edges)", 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);
+		options[1].def = g_variant_new_string(DEFAULT_ASCII_CHARS);
+		g_variant_ref_sink(options[1].def);
+	}
+
+	return options;
+}
+
+SR_PRIV struct sr_output_module output_ascii = {
 	.id = "ascii",
-	.description = "ASCII",
+	.name = "ASCII",
+	.desc = "ASCII art logic data",
+	.exts = (const char*[]){"txt", NULL},
+	.flags = 0,
+	.options = get_options,
 	.init = init,
 	.receive = receive,
 	.cleanup = cleanup,
 };
-
-