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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2011 Håvard Espeland <gus@ping.uio.no>
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * 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/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;
	int spl_cnt;
	int trigger;
	uint64_t samplerate;
	int *channel_index;
	GString **channel_names;
	int 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, GHashTable *options)
{
	struct context *ctx;
	struct sr_channel *ch;
	GSList *l;
	unsigned int i, j, max_namelen;

	if (!o || !o->sdi)
		return SR_ERR_ARG;

	ctx = g_malloc0(sizeof(struct context));
	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;
		if (ch->type != SR_CHANNEL_LOGIC)
			continue;
		if (!ch->enabled)
			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));

	max_namelen = 0;
	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
		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;

	j = 0;
	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
		ch = l->data;
		if (ch->type != SR_CHANNEL_LOGIC)
			continue;
		if (!ch->enabled)
			continue;

		ctx->channel_index[j] = ch->index;
		ctx->channel_names[j] = g_string_sized_new(16);
		g_string_printf(ctx->channel_names[j], "%*s%s", (int)(max_namelen - strlen(ch->name)), "", ch->name);

		ctx->lines[j] = g_string_sized_new(80);
		g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]->str);

		j++;
	}

	return SR_OK;
}

static GString *gen_header(const struct sr_output *o)
{
	struct context *ctx;
	GVariant *gvar;
	GString *header;
	int num_channels;
	char *samplerate_s;

	ctx = o->priv;
	if (ctx->samplerate == 0) {
		if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
				&gvar) == SR_OK) {
			ctx->samplerate = g_variant_get_uint64(gvar);
			g_variant_unref(gvar);
		}
	}

	header = g_string_sized_new(512);
	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",
			ctx->num_enabled_channels, num_channels);
	if (ctx->samplerate != 0) {
		samplerate_s = sr_samplerate_string(ctx->samplerate);
		g_string_append_printf(header, " at %s", samplerate_s);
		g_free(samplerate_s);
	}
	g_string_append_printf(header, "\n");

	return header;
}

static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	const struct sr_datafeed_meta *meta;
	const struct sr_datafeed_logic *logic;
	const struct sr_config *src;
	GSList *l;
	struct context *ctx;
	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->priv))
		return SR_ERR_ARG;

	switch (packet->type) {
	case SR_DF_META:
		meta = packet->payload;
		for (l = meta->config; l; l = l->next) {
			src = l->data;
			if (src->key != SR_CONF_SAMPLERATE)
				continue;
			ctx->samplerate = g_variant_get_uint64(src->data);
		}
		break;
	case SR_DF_TRIGGER:
		ctx->trigger = ctx->spl_cnt;
		break;
	case SR_DF_LOGIC:
		if (!ctx->header_done) {
			*out = gen_header(o);
			ctx->header_done = TRUE;
		} else
			*out = g_string_sized_new(512);

		logic = packet->payload;
		for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
			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)));

				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) {
						/*
						 * Sample data lines have one character per bit and
						 * no separator between bytes. Align trigger marker
						 * to this layout.
						 */
						offset = ctx->trigger;
						g_string_append_printf(*out, "%*sT:%*s^ %d\n", ctx->max_namelen - 1, "", offset, "", ctx->trigger);
						ctx->trigger = -1;
					}
					g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]->str);
				}
			}
			if (ctx->spl_cnt == ctx->spl)
				/* Line buffers were already flushed. */
				ctx->spl_cnt = 0;
			memcpy(ctx->prev_sample, logic->data + i, logic->unitsize);
		}
		break;
	case SR_DF_END:
		if (ctx->spl_cnt) {
			/* Line buffers need flushing. */
			*out = g_string_sized_new(512);
			for (i = 0; i < ctx->num_enabled_channels; i++) {
				g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
				g_string_append_c(*out, '\n');
			}
		}
		break;
	}

	return SR_OK;
}

static int cleanup(struct sr_output *o)
{
	struct context *ctx;
	unsigned int i;

	if (!o)
		return SR_ERR_ARG;

	if (!(ctx = o->priv))
		return SR_OK;

	g_free(ctx->channel_index);
	g_free(ctx->prev_sample);
	for (i = 0; i < ctx->num_enabled_channels; i++) {
		g_string_free(ctx->channel_names[i], TRUE);
		g_string_free(ctx->lines[i], TRUE);
	}
	g_free(ctx->channel_names);
	g_free(ctx->lines);
	g_free((gpointer)ctx->charset);
	g_free(ctx);
	o->priv = NULL;

	return SR_OK;
}

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",
	.name = "ASCII",
	.desc = "ASCII art logic data",
	.exts = (const char*[]){"txt", NULL},
	.flags = 0,
	.options = get_options,
	.init = init,
	.receive = receive,
	.cleanup = cleanup,
};
Commit	Line	Data
6f64ebb2 BV	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
6ec6c43b	21	#include <config.h>
6f64ebb2 BV	22	#include <stdlib.h>
	23	#include <string.h>
	24	#include <glib.h>
c1aae900	25	#include <libsigrok/libsigrok.h>
6f64ebb2 BV	26	#include "libsigrok-internal.h"
	27
	28	#define LOG_PREFIX "output/hex"
	29
	30	#define DEFAULT_SAMPLES_PER_LINE 74
	31
0150fdca GS	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
6f64ebb2 BV	39	struct context {
6f64ebb2 BV	40	unsigned int num_enabled_channels;
dcc55fe9	41	int spl;
6f64ebb2 BV	42	int spl_cnt;
6f64ebb2 BV	43	int trigger;
787e9bc9	44	uint64_t samplerate;
6f64ebb2	45	int *channel_index;
3b93d3c2	46	GString **channel_names;
3b93d3c2	47	int max_namelen;
6f64ebb2 BV	48	char **line_values;
6f64ebb2 BV	49	uint8_t *prev_sample;
787e9bc9	50	gboolean header_done;
6f64ebb2 BV	51	GString **lines;
6f64ebb2 BV	52	GString *header;
0150fdca GS	53	const char *charset;
0150fdca GS	54	gboolean edges;
6f64ebb2 BV	55	};
6f64ebb2 BV	56
a755b0e1	57	static int init(struct sr_output o, GHashTable options)
6f64ebb2 BV	58	{
	59	struct context *ctx;
	60	struct sr_channel *ch;
	61	GSList *l;
3b93d3c2	62	unsigned int i, j, max_namelen;
6f64ebb2 BV	63
	64	if (!o \|\| !o->sdi)
	65	return SR_ERR_ARG;
dba3e682	66
6f64ebb2	67	ctx = g_malloc0(sizeof(struct context));
d686c5ec	68	o->priv = ctx;
6f64ebb2	69	ctx->trigger = -1;
dcc55fe9	70	ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));
0150fdca GS	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;
6f64ebb2 BV	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_malloc(sizeof(int) * ctx->num_enabled_channels);
	88	ctx->channel_names = g_malloc(sizeof(char ) ctx->num_enabled_channels);
	89	ctx->lines = g_malloc(sizeof(GString ) ctx->num_enabled_channels);
	90	ctx->prev_sample = g_malloc(g_slist_length(o->sdi->channels));
	91
3b93d3c2	92	max_namelen = 0;
	93	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
	94	ch = l->data;
	95	if (ch->type != SR_CHANNEL_LOGIC)
	96	continue;
	97	if (!ch->enabled)
	98	continue;
	99
	100	max_namelen = MAX(max_namelen, strlen(ch->name));
	101	}
	102	ctx->max_namelen = max_namelen;
	103
6f64ebb2 BV	104	j = 0;
	105	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
	106	ch = l->data;
	107	if (ch->type != SR_CHANNEL_LOGIC)
	108	continue;
	109	if (!ch->enabled)
	110	continue;
3b93d3c2	111
6f64ebb2	112	ctx->channel_index[j] = ch->index;
3b93d3c2	113	ctx->channel_names[j] = g_string_sized_new(16);
	114	g_string_printf(ctx->channel_names[j], "%*s%s", (int)(max_namelen - strlen(ch->name)), "", ch->name);
	115
6f64ebb2	116	ctx->lines[j] = g_string_sized_new(80);
3b93d3c2	117	g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]->str);
3b93d3c2	118
6f64ebb2 BV	119	j++;
	120	}
	121
787e9bc9 BV	122	return SR_OK;
	123	}
	124
a755b0e1	125	static GString gen_header(const struct sr_output o)
787e9bc9 BV	126	{
	127	struct context *ctx;
	128	GVariant *gvar;
	129	GString *header;
	130	int num_channels;
	131	char *samplerate_s;
	132
d686c5ec	133	ctx = o->priv;
787e9bc9 BV	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);
2868bca3	143	g_string_printf(header, "%s %s\n", PACKAGE_NAME, sr_package_version_string_get());
6f64ebb2	144	num_channels = g_slist_length(o->sdi->channels);
787e9bc9 BV	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);
6f64ebb2	150	g_free(samplerate_s);
6f64ebb2	151	}
787e9bc9	152	g_string_append_printf(header, "\n");
6f64ebb2	153
787e9bc9	154	return header;
6f64ebb2 BV	155	}
6f64ebb2 BV	156
a755b0e1	157	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
dba3e682	158	GString **out)
6f64ebb2	159	{
787e9bc9	160	const struct sr_datafeed_meta *meta;
6f64ebb2	161	const struct sr_datafeed_logic *logic;
787e9bc9 BV	162	const struct sr_config *src;
787e9bc9 BV	163	GSList *l;
6f64ebb2 BV	164	struct context *ctx;
	165	int idx, offset, curbit, prevbit;
	166	uint64_t i, j;
	167	gchar *p, c;
0150fdca	168	size_t charidx;
6f64ebb2	169
6f64ebb2 BV	170	*out = NULL;
	171	if (!o \|\| !o->sdi)
	172	return SR_ERR_ARG;
d686c5ec	173	if (!(ctx = o->priv))
6f64ebb2 BV	174	return SR_ERR_ARG;
	175
	176	switch (packet->type) {
787e9bc9 BV	177	case SR_DF_META:
	178	meta = packet->payload;
	179	for (l = meta->config; l; l = l->next) {
	180	src = l->data;
	181	if (src->key != SR_CONF_SAMPLERATE)
	182	continue;
	183	ctx->samplerate = g_variant_get_uint64(src->data);
	184	}
	185	break;
6f64ebb2 BV	186	case SR_DF_TRIGGER:
	187	ctx->trigger = ctx->spl_cnt;
	188	break;
	189	case SR_DF_LOGIC:
787e9bc9 BV	190	if (!ctx->header_done) {
	191	*out = gen_header(o);
	192	ctx->header_done = TRUE;
6f64ebb2 BV	193	} else
	194	*out = g_string_sized_new(512);
	195
	196	logic = packet->payload;
	197	for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
	198	ctx->spl_cnt++;
	199	for (j = 0; j < ctx->num_enabled_channels; j++) {
	200	idx = ctx->channel_index[j];
	201	p = logic->data + i + idx / 8;
	202	curbit = *p & (1 << (idx % 8));
	203	prevbit = (ctx->prev_sample[idx / 8] & ((uint8_t) 1 << (idx % 8)));
	204
0150fdca GS	205	charidx = curbit ? 1 : 0;
	206	if (ctx->edges && ctx->spl_cnt > 1) {
	207	if (curbit != prevbit)
	208	charidx += 2;
6f64ebb2	209	}
0150fdca	210	c = ctx->charset[charidx];
6f64ebb2 BV	211	g_string_append_c(ctx->lines[j], c);
6f64ebb2 BV	212
dcc55fe9	213	if (ctx->spl_cnt == ctx->spl) {
6f64ebb2 BV	214	/* Flush line buffers. */
	215	g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
	216	g_string_append_c(*out, '\n');
d9251a2c	217	if (j == ctx->num_enabled_channels - 1 && ctx->trigger > -1) {
67b345b9	218	/*
3387a5d8 GS	219	* Sample data lines have one character per bit and
	220	* no separator between bytes. Align trigger marker
	221	* to this layout.
67b345b9 GS	222	*/
67b345b9 GS	223	offset = ctx->trigger;
3b93d3c2	224	g_string_append_printf(out, "%sT:%*s^ %d\n", ctx->max_namelen - 1, "", offset, "", ctx->trigger);
6f64ebb2 BV	225	ctx->trigger = -1;
6f64ebb2 BV	226	}
3b93d3c2	227	g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]->str);
6f64ebb2 BV	228	}
6f64ebb2 BV	229	}
dcc55fe9	230	if (ctx->spl_cnt == ctx->spl)
6f64ebb2 BV	231	/* Line buffers were already flushed. */
	232	ctx->spl_cnt = 0;
	233	memcpy(ctx->prev_sample, logic->data + i, logic->unitsize);
	234	}
	235	break;
	236	case SR_DF_END:
	237	if (ctx->spl_cnt) {
	238	/* Line buffers need flushing. */
	239	*out = g_string_sized_new(512);
	240	for (i = 0; i < ctx->num_enabled_channels; i++) {
	241	g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
	242	g_string_append_c(*out, '\n');
	243	}
	244	}
	245	break;
	246	}
	247
	248	return SR_OK;
	249	}
	250
	251	static int cleanup(struct sr_output *o)
	252	{
	253	struct context *ctx;
	254	unsigned int i;
	255
	256	if (!o)
	257	return SR_ERR_ARG;
	258
d686c5ec	259	if (!(ctx = o->priv))
6f64ebb2 BV	260	return SR_OK;
6f64ebb2 BV	261
6f64ebb2 BV	262	g_free(ctx->channel_index);
6f64ebb2 BV	263	g_free(ctx->prev_sample);
3b93d3c2	264	for (i = 0; i < ctx->num_enabled_channels; i++) {
3b93d3c2	265	g_string_free(ctx->channel_names[i], TRUE);
6f64ebb2	266	g_string_free(ctx->lines[i], TRUE);
3b93d3c2	267	}
3b93d3c2	268	g_free(ctx->channel_names);
6f64ebb2	269	g_free(ctx->lines);
0150fdca	270	g_free((gpointer)ctx->charset);
6f64ebb2	271	g_free(ctx);
d686c5ec	272	o->priv = NULL;
6f64ebb2 BV	273
	274	return SR_OK;
	275	}
	276
a755b0e1 BV	277	static struct sr_option options[] = {
a755b0e1 BV	278	{ "width", "Width", "Number of samples per line", NULL, NULL },
0150fdca	279	{ "charset", "Charset", "Characters for 0/1 bits (and fall/rise edges)", NULL, NULL },
1685c276	280	ALL_ZERO
a755b0e1 BV	281	};
a755b0e1 BV	282
af7d656d	283	static const struct sr_option *get_options(void)
a755b0e1	284	{
950043c3 BV	285	if (!options[0].def) {
	286	options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
	287	g_variant_ref_sink(options[0].def);
0150fdca GS	288	options[1].def = g_variant_new_string(DEFAULT_ASCII_CHARS);
0150fdca GS	289	g_variant_ref_sink(options[1].def);
950043c3	290	}
a755b0e1 BV	291
	292	return options;
	293	}
	294
	295	SR_PRIV struct sr_output_module output_ascii = {
6f64ebb2	296	.id = "ascii",
a755b0e1	297	.name = "ASCII",
b20eb520	298	.desc = "ASCII art logic data",
8a174d23	299	.exts = (const char*[]){"txt", NULL},
3cd4b381	300	.flags = 0,
a755b0e1	301	.options = get_options,
6f64ebb2 BV	302	.init = init,
	303	.receive = receive,
	304	.cleanup = cleanup,
	305	};