[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 bit_cnt;
	int spl_cnt;
	int trigger;
	uint64_t samplerate;
	int *channel_index;
	char **channel_names;
	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;

	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));

	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] = ch->name;
		ctx->lines[j] = g_string_sized_new(80);
		g_string_printf(ctx->lines[j], "%s:", ch->name);
		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);
	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) {
						/*
						 * 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->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);
	g_free(ctx->channel_names);
	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;

	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 bit_cnt;
	43	int spl_cnt;
	44	int trigger;
787e9bc9	45	uint64_t samplerate;
6f64ebb2 BV	46	int *channel_index;
	47	char **channel_names;
	48	char **line_values;
	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;
6f64ebb2	62	unsigned int i, j;
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
	92	j = 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	ctx->channel_index[j] = ch->index;
	100	ctx->channel_names[j] = ch->name;
	101	ctx->lines[j] = g_string_sized_new(80);
	102	g_string_printf(ctx->lines[j], "%s:", ch->name);
	103	j++;
	104	}
	105
787e9bc9 BV	106	return SR_OK;
	107	}
	108
a755b0e1	109	static GString gen_header(const struct sr_output o)
787e9bc9 BV	110	{
	111	struct context *ctx;
	112	GVariant *gvar;
	113	GString *header;
	114	int num_channels;
	115	char *samplerate_s;
	116
d686c5ec	117	ctx = o->priv;
787e9bc9 BV	118	if (ctx->samplerate == 0) {
	119	if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
	120	&gvar) == SR_OK) {
	121	ctx->samplerate = g_variant_get_uint64(gvar);
	122	g_variant_unref(gvar);
	123	}
	124	}
	125
	126	header = g_string_sized_new(512);
b9eb8e1a	127	g_string_printf(header, "%s %s\n", PACKAGE_NAME, SR_PACKAGE_VERSION_STRING);
6f64ebb2	128	num_channels = g_slist_length(o->sdi->channels);
787e9bc9 BV	129	g_string_append_printf(header, "Acquisition with %d/%d channels",
	130	ctx->num_enabled_channels, num_channels);
	131	if (ctx->samplerate != 0) {
	132	samplerate_s = sr_samplerate_string(ctx->samplerate);
	133	g_string_append_printf(header, " at %s", samplerate_s);
6f64ebb2	134	g_free(samplerate_s);
6f64ebb2	135	}
787e9bc9	136	g_string_append_printf(header, "\n");
6f64ebb2	137
787e9bc9	138	return header;
6f64ebb2 BV	139	}
6f64ebb2 BV	140
a755b0e1	141	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
dba3e682	142	GString **out)
6f64ebb2	143	{
787e9bc9	144	const struct sr_datafeed_meta *meta;
6f64ebb2	145	const struct sr_datafeed_logic *logic;
787e9bc9 BV	146	const struct sr_config *src;
787e9bc9 BV	147	GSList *l;
6f64ebb2 BV	148	struct context *ctx;
	149	int idx, offset, curbit, prevbit;
	150	uint64_t i, j;
	151	gchar *p, c;
0150fdca	152	size_t charidx;
6f64ebb2	153
6f64ebb2 BV	154	*out = NULL;
	155	if (!o \|\| !o->sdi)
	156	return SR_ERR_ARG;
d686c5ec	157	if (!(ctx = o->priv))
6f64ebb2 BV	158	return SR_ERR_ARG;
	159
	160	switch (packet->type) {
787e9bc9 BV	161	case SR_DF_META:
	162	meta = packet->payload;
	163	for (l = meta->config; l; l = l->next) {
	164	src = l->data;
	165	if (src->key != SR_CONF_SAMPLERATE)
	166	continue;
	167	ctx->samplerate = g_variant_get_uint64(src->data);
	168	}
	169	break;
6f64ebb2 BV	170	case SR_DF_TRIGGER:
	171	ctx->trigger = ctx->spl_cnt;
	172	break;
	173	case SR_DF_LOGIC:
787e9bc9 BV	174	if (!ctx->header_done) {
	175	*out = gen_header(o);
	176	ctx->header_done = TRUE;
6f64ebb2 BV	177	} else
	178	*out = g_string_sized_new(512);
	179
	180	logic = packet->payload;
	181	for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
	182	ctx->spl_cnt++;
	183	for (j = 0; j < ctx->num_enabled_channels; j++) {
	184	idx = ctx->channel_index[j];
	185	p = logic->data + i + idx / 8;
	186	curbit = *p & (1 << (idx % 8));
	187	prevbit = (ctx->prev_sample[idx / 8] & ((uint8_t) 1 << (idx % 8)));
	188
0150fdca GS	189	charidx = curbit ? 1 : 0;
	190	if (ctx->edges && ctx->spl_cnt > 1) {
	191	if (curbit != prevbit)
	192	charidx += 2;
6f64ebb2	193	}
0150fdca	194	c = ctx->charset[charidx];
6f64ebb2 BV	195	g_string_append_c(ctx->lines[j], c);
6f64ebb2 BV	196
dcc55fe9	197	if (ctx->spl_cnt == ctx->spl) {
6f64ebb2 BV	198	/* Flush line buffers. */
	199	g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
	200	g_string_append_c(*out, '\n');
d9251a2c	201	if (j == ctx->num_enabled_channels - 1 && ctx->trigger > -1) {
67b345b9 GS	202	/*
	203	* Each group of 8 bits occupies 8 bit positions
	204	* and no separator. With this dense presentation
	205	* the "calculation" of the trigger position is
	206	* rather straight forward.
	207	*/
	208	offset = ctx->trigger;
6f64ebb2 BV	209	g_string_append_printf(out, "T:%s^ %d\n", offset, "", ctx->trigger);
	210	ctx->trigger = -1;
	211	}
	212	g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
	213	}
	214	}
dcc55fe9	215	if (ctx->spl_cnt == ctx->spl)
6f64ebb2 BV	216	/* Line buffers were already flushed. */
	217	ctx->spl_cnt = 0;
	218	memcpy(ctx->prev_sample, logic->data + i, logic->unitsize);
	219	}
	220	break;
	221	case SR_DF_END:
	222	if (ctx->spl_cnt) {
	223	/* Line buffers need flushing. */
	224	*out = g_string_sized_new(512);
	225	for (i = 0; i < ctx->num_enabled_channels; i++) {
	226	g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
	227	g_string_append_c(*out, '\n');
	228	}
	229	}
	230	break;
	231	}
	232
	233	return SR_OK;
	234	}
	235
	236	static int cleanup(struct sr_output *o)
	237	{
	238	struct context *ctx;
	239	unsigned int i;
	240
	241	if (!o)
	242	return SR_ERR_ARG;
	243
d686c5ec	244	if (!(ctx = o->priv))
6f64ebb2 BV	245	return SR_OK;
6f64ebb2 BV	246
6f64ebb2 BV	247	g_free(ctx->channel_index);
	248	g_free(ctx->prev_sample);
	249	g_free(ctx->channel_names);
	250	for (i = 0; i < ctx->num_enabled_channels; i++)
	251	g_string_free(ctx->lines[i], TRUE);
	252	g_free(ctx->lines);
0150fdca	253	g_free((gpointer)ctx->charset);
6f64ebb2	254	g_free(ctx);
d686c5ec	255	o->priv = NULL;
6f64ebb2 BV	256
	257	return SR_OK;
	258	}
	259
a755b0e1 BV	260	static struct sr_option options[] = {
a755b0e1 BV	261	{ "width", "Width", "Number of samples per line", NULL, NULL },
0150fdca	262	{ "charset", "Charset", "Characters for 0/1 bits (and fall/rise edges)", NULL, NULL },
1685c276	263	ALL_ZERO
a755b0e1 BV	264	};
a755b0e1 BV	265
af7d656d	266	static const struct sr_option *get_options(void)
a755b0e1	267	{
950043c3 BV	268	if (!options[0].def) {
	269	options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
	270	g_variant_ref_sink(options[0].def);
0150fdca GS	271	options[1].def = g_variant_new_string(DEFAULT_ASCII_CHARS);
0150fdca GS	272	g_variant_ref_sink(options[1].def);
950043c3	273	}
a755b0e1 BV	274
	275	return options;
	276	}
	277
	278	SR_PRIV struct sr_output_module output_ascii = {
6f64ebb2	279	.id = "ascii",
a755b0e1	280	.name = "ASCII",
b20eb520	281	.desc = "ASCII art logic data",
8a174d23	282	.exts = (const char*[]){"txt", NULL},
3cd4b381	283	.flags = 0,
a755b0e1	284	.options = get_options,
6f64ebb2 BV	285	.init = init,
	286	.receive = receive,
	287	.cleanup = cleanup,
	288	};