[libsigrok.git] / output / output_text.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010 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 <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <glib.h>
#include <sigrok.h>

#define DEFAULT_BPL_BITS 64
#define DEFAULT_BPL_HEX  256

struct context {
	unsigned int num_enabled_probes;
	int samples_per_line;
	unsigned int unitsize;
	int line_offset;
	int linebuf_len;
	char *probelist[65];
	char *linebuf;
	int spl_cnt;
	uint8_t *linevalues;
	char *header;
	int mark_trigger;
};

static void flush_linebufs(struct context *ctx, char *outbuf)
{
	static int max_probename_len = 0;
	int len, i;

	if (ctx->linebuf[0] == 0)
		return;

	if (max_probename_len == 0) {
		/* First time through... */
		for (i = 0; ctx->probelist[i]; i++) {
			len = strlen(ctx->probelist[i]);
			if (len > max_probename_len)
				max_probename_len = len;
		}
	}

	for (i = 0; ctx->probelist[i]; i++) {
		sprintf(outbuf + strlen(outbuf), "%*s:%s\n", max_probename_len,
			ctx->probelist[i], ctx->linebuf + i * ctx->linebuf_len);
	}

	/* Mark trigger with ^ */
	if (ctx->mark_trigger != -1)
		sprintf(outbuf + strlen(outbuf), "T:%*s^\n",
			ctx->mark_trigger + (ctx->mark_trigger / 8), "");

	memset(ctx->linebuf, 0, i * ctx->linebuf_len);
}

static int init(struct output *o, int default_spl)
{
	struct context *ctx;
	struct probe *probe;
	GSList *l;
	uint64_t samplerate;
	int num_probes;
	char *samplerate_s;

	ctx = malloc(sizeof(struct context));
	o->internal = ctx;
	ctx->num_enabled_probes = 0;

	for (l = o->device->probes; l; l = l->next) {
		probe = l->data;
		if (probe->enabled)
			ctx->probelist[ctx->num_enabled_probes++] = probe->name;
	}

	ctx->probelist[ctx->num_enabled_probes] = 0;
	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
	ctx->line_offset = 0;
	ctx->spl_cnt = 0;
	ctx->mark_trigger = -1;

	if (o->param && o->param[0])
		ctx->samples_per_line = strtoul(o->param, NULL, 10);
	else
		ctx->samples_per_line = default_spl;

	if (o->device->plugin) {
		ctx->header = malloc(512);
		num_probes = g_slist_length(o->device->probes);
		samplerate = *((uint64_t *) o->device->plugin->get_device_info(
				o->device->plugin_index, DI_CUR_SAMPLERATE));
		snprintf(ctx->header, 512, "Acquisition with %d/%d probes at ",
			 ctx->num_enabled_probes, num_probes);

		if ((samplerate_s = sigrok_samplerate_string(samplerate)) == NULL)
			return -1; /* FIXME */
		snprintf(ctx->header + strlen(ctx->header), 512, "%s\n", samplerate_s);
		free(samplerate_s);
	} else {
		/*
		 * device has no plugin: this is just a dummy device, the data
		 * comes from a file.
		 */
		ctx->header = NULL;
	}

	ctx->linebuf_len = ctx->samples_per_line * 2;
	ctx->linebuf = calloc(1, num_probes * ctx->linebuf_len);
	ctx->linevalues = calloc(1, num_probes);

	return 0;
}

static int event(struct output *o, int event_type, char **data_out,
		 uint64_t *length_out)
{
	struct context *ctx;
	int outsize;
	char *outbuf;

	ctx = o->internal;
	switch (event_type) {
	case DF_TRIGGER:
		ctx->mark_trigger = ctx->spl_cnt;
		break;
	case DF_END:
		outsize = ctx->num_enabled_probes
				* (ctx->samples_per_line + 20) + 512;
		outbuf = calloc(1, outsize);
		flush_linebufs(ctx, outbuf);
		*data_out = outbuf;
		*length_out = strlen(outbuf);
		free(o->internal);
		o->internal = NULL;
		break;
	}

	return SIGROK_OK;
}

static int init_bits(struct output *o)
{
	return init(o, DEFAULT_BPL_BITS);
}

static int data_bits(struct output *o, char *data_in, uint64_t length_in,
		     char **data_out, uint64_t *length_out)
{
	struct context *ctx;
	unsigned int outsize, offset, p;
	uint64_t sample;
	char *outbuf;

	ctx = o->internal;
	outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
		  ctx->samples_per_line + 512;
	outbuf = calloc(1, outsize + 1);
	if (ctx->header) {
		/* The header is still here, this must be the first packet. */
		strncpy(outbuf, ctx->header, outsize);
		free(ctx->header);
		ctx->header = NULL;
	} else
		outbuf[0] = 0;

	if (length_in >= ctx->unitsize) {
		for (offset = 0; offset <= length_in - ctx->unitsize;
		     offset += ctx->unitsize) {
			memcpy(&sample, data_in + offset, ctx->unitsize);
			for (p = 0; p < ctx->num_enabled_probes; p++) {
				if (sample & ((uint64_t) 1 << p))
					ctx->linebuf[p * ctx->linebuf_len +
						     ctx->line_offset] = '1';
				else
					ctx->linebuf[p * ctx->linebuf_len +
						     ctx->line_offset] = '0';
			}
			ctx->line_offset++;
			ctx->spl_cnt++;

			/* Add a space every 8th bit. */
			if ((ctx->spl_cnt & 7) == 0) {
				for (p = 0; p < ctx->num_enabled_probes; p++)
					ctx->linebuf[p * ctx->linebuf_len +
						     ctx->line_offset] = ' ';
				ctx->line_offset++;
			}

			/* End of line. */
			if (ctx->spl_cnt >= ctx->samples_per_line) {
				flush_linebufs(ctx, outbuf);
				ctx->line_offset = ctx->spl_cnt = 0;
				ctx->mark_trigger = -1;
			}
		}
	} else
		g_message("short buffer (length_in=%" PRIu64 ")", length_in);

	*data_out = outbuf;
	*length_out = strlen(outbuf);

	return SIGROK_OK;
}

static int init_hex(struct output *o)
{
	return init(o, DEFAULT_BPL_BITS);
}

static int data_hex(struct output *o, char *data_in, uint64_t length_in,
		    char **data_out, uint64_t *length_out)
{
	struct context *ctx;
	unsigned int outsize, offset, p;
	uint64_t sample;
	char *outbuf;

	ctx = o->internal;
	outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
		  ctx->samples_per_line + 512;
	outbuf = calloc(1, outsize + 1);
	if (ctx->header) {
		/* The header is still here, this must be the first packet. */
		strncpy(outbuf, ctx->header, outsize);
		free(ctx->header);
		ctx->header = NULL;
	} else
		outbuf[0] = 0;

	ctx->line_offset = 0;
	for (offset = 0; offset <= length_in - ctx->unitsize;
	     offset += ctx->unitsize) {
		memcpy(&sample, data_in + offset, ctx->unitsize);
		for (p = 0; p < ctx->num_enabled_probes; p++) {
			ctx->linevalues[p] <<= 1;
			if (sample & ((uint64_t) 1 << p))
				ctx->linevalues[p] |= 1;
			sprintf(ctx->linebuf + (p * ctx->linebuf_len) +
				ctx->line_offset, "%.2x", ctx->linevalues[p]);
		}
		ctx->spl_cnt++;

		/* Add a space after every complete hex byte. */
		if ((ctx->spl_cnt & 7) == 0) {
			for (p = 0; p < ctx->num_enabled_probes; p++)
				ctx->linebuf[p * ctx->linebuf_len +
					     ctx->line_offset + 2] = ' ';
			ctx->line_offset += 3;
		}

		/* End of line. */
		if (ctx->spl_cnt >= ctx->samples_per_line) {
			flush_linebufs(ctx, outbuf);
			ctx->line_offset = ctx->spl_cnt = 0;
		}
	}

	*data_out = outbuf;
	*length_out = strlen(outbuf);

	return SIGROK_OK;
}

struct output_format output_text_bits = {
	"bits",
	"Text (bits)",
	init_bits,
	data_bits,
	event,
};

struct output_format output_text_hex = {
	"hex",
	"Text (hexadecimal)",
	init_hex,
	data_hex,
	event,
};
Commit	Line	Data
a1bb33af UH	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <stdlib.h>
	21	#include <stdio.h>
	22	#include <string.h>
	23	#include <glib.h>
25e7d9b1	24	#include <sigrok.h>
a1bb33af	25
02076d69 UH	26	#define DEFAULT_BPL_BITS 64
02076d69 UH	27	#define DEFAULT_BPL_HEX 256
a1bb33af UH	28
a1bb33af UH	29	struct context {
afc8e4de	30	unsigned int num_enabled_probes;
a1bb33af	31	int samples_per_line;
afc8e4de	32	unsigned int unitsize;
a1bb33af UH	33	int line_offset;
	34	int linebuf_len;
	35	char *probelist[65];
	36	char *linebuf;
	37	int spl_cnt;
	38	uint8_t *linevalues;
	39	char *header;
5045c217	40	int mark_trigger;
a1bb33af UH	41	};
a1bb33af UH	42
afc8e4de	43	static void flush_linebufs(struct context ctx, char outbuf)
a1bb33af UH	44	{
	45	static int max_probename_len = 0;
	46	int len, i;
	47
99c1fc59	48	if (ctx->linebuf[0] == 0)
a1bb33af UH	49	return;
a1bb33af UH	50
99c1fc59 UH	51	if (max_probename_len == 0) {
	52	/* First time through... */
	53	for (i = 0; ctx->probelist[i]; i++) {
a1bb33af	54	len = strlen(ctx->probelist[i]);
99c1fc59	55	if (len > max_probename_len)
a1bb33af UH	56	max_probename_len = len;
	57	}
	58	}
	59
99c1fc59 UH	60	for (i = 0; ctx->probelist[i]; i++) {
	61	sprintf(outbuf + strlen(outbuf), "%*s:%s\n", max_probename_len,
	62	ctx->probelist[i], ctx->linebuf + i * ctx->linebuf_len);
a1bb33af	63	}
5045c217 HE	64
	65	/* Mark trigger with ^ */
	66	if (ctx->mark_trigger != -1)
	67	sprintf(outbuf + strlen(outbuf), "T:%*s^\n",
	68	ctx->mark_trigger + (ctx->mark_trigger / 8), "");
	69
a1bb33af	70	memset(ctx->linebuf, 0, i * ctx->linebuf_len);
a1bb33af UH	71	}
a1bb33af UH	72
5a8fda15	73	static int init(struct output *o, int default_spl)
a1bb33af UH	74	{
	75	struct context *ctx;
	76	struct probe *probe;
	77	GSList *l;
	78	uint64_t samplerate;
	79	int num_probes;
25e7d9b1	80	char *samplerate_s;
a1bb33af UH	81
	82	ctx = malloc(sizeof(struct context));
	83	o->internal = ctx;
	84	ctx->num_enabled_probes = 0;
99c1fc59 UH	85
99c1fc59 UH	86	for (l = o->device->probes; l; l = l->next) {
a1bb33af	87	probe = l->data;
99c1fc59	88	if (probe->enabled)
a1bb33af UH	89	ctx->probelist[ctx->num_enabled_probes++] = probe->name;
a1bb33af UH	90	}
99c1fc59	91
a1bb33af UH	92	ctx->probelist[ctx->num_enabled_probes] = 0;
	93	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
	94	ctx->line_offset = 0;
	95	ctx->spl_cnt = 0;
5045c217	96	ctx->mark_trigger = -1;
99c1fc59 UH	97
99c1fc59 UH	98	if (o->param && o->param[0])
a1bb33af UH	99	ctx->samples_per_line = strtoul(o->param, NULL, 10);
	100	else
	101	ctx->samples_per_line = default_spl;
	102
7aae7462 BV	103	if (o->device->plugin) {
	104	ctx->header = malloc(512);
	105	num_probes = g_slist_length(o->device->probes);
	106	samplerate = ((uint64_t ) o->device->plugin->get_device_info(
	107	o->device->plugin_index, DI_CUR_SAMPLERATE));
	108	snprintf(ctx->header, 512, "Acquisition with %d/%d probes at ",
	109	ctx->num_enabled_probes, num_probes);
	110
	111	if ((samplerate_s = sigrok_samplerate_string(samplerate)) == NULL)
	112	return -1; /* FIXME */
	113	snprintf(ctx->header + strlen(ctx->header), 512, "%s\n", samplerate_s);
	114	free(samplerate_s);
	115	} else {
	116	/*
	117	* device has no plugin: this is just a dummy device, the data
	118	* comes from a file.
	119	*/
	120	ctx->header = NULL;
	121	}
a1bb33af UH	122
	123	ctx->linebuf_len = ctx->samples_per_line * 2;
	124	ctx->linebuf = calloc(1, num_probes * ctx->linebuf_len);
	125	ctx->linevalues = calloc(1, num_probes);
	126
5a8fda15	127	return 0;
a1bb33af UH	128	}
a1bb33af UH	129
99c1fc59 UH	130	static int event(struct output o, int event_type, char *data_out,
99c1fc59 UH	131	uint64_t *length_out)
a1bb33af UH	132	{
	133	struct context *ctx;
	134	int outsize;
	135	char *outbuf;
	136
	137	ctx = o->internal;
99c1fc59	138	switch (event_type) {
a1bb33af	139	case DF_TRIGGER:
5045c217	140	ctx->mark_trigger = ctx->spl_cnt;
a1bb33af UH	141	break;
a1bb33af UH	142	case DF_END:
99c1fc59 UH	143	outsize = ctx->num_enabled_probes
99c1fc59 UH	144	* (ctx->samples_per_line + 20) + 512;
a1bb33af	145	outbuf = calloc(1, outsize);
afc8e4de	146	flush_linebufs(ctx, outbuf);
a1bb33af UH	147	*data_out = outbuf;
	148	*length_out = strlen(outbuf);
	149	free(o->internal);
	150	o->internal = NULL;
	151	break;
	152	}
	153
	154	return SIGROK_OK;
	155	}
	156
02076d69	157	static int init_bits(struct output *o)
a1bb33af	158	{
02076d69	159	return init(o, DEFAULT_BPL_BITS);
a1bb33af UH	160	}
a1bb33af UH	161
99c1fc59 UH	162	static int data_bits(struct output o, char data_in, uint64_t length_in,
99c1fc59 UH	163	char *data_out, uint64_t length_out)
a1bb33af UH	164	{
a1bb33af UH	165	struct context *ctx;
afc8e4de	166	unsigned int outsize, offset, p;
a1bb33af UH	167	uint64_t sample;
	168	char *outbuf;
	169
	170	ctx = o->internal;
99c1fc59 UH	171	outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
	172	ctx->samples_per_line + 512;
	173	outbuf = calloc(1, outsize + 1);
	174	if (ctx->header) {
	175	/* The header is still here, this must be the first packet. */
a1bb33af UH	176	strncpy(outbuf, ctx->header, outsize);
	177	free(ctx->header);
	178	ctx->header = NULL;
99c1fc59	179	} else
a1bb33af UH	180	outbuf[0] = 0;
a1bb33af UH	181
99c1fc59 UH	182	if (length_in >= ctx->unitsize) {
	183	for (offset = 0; offset <= length_in - ctx->unitsize;
	184	offset += ctx->unitsize) {
a1bb33af	185	memcpy(&sample, data_in + offset, ctx->unitsize);
99c1fc59 UH	186	for (p = 0; p < ctx->num_enabled_probes; p++) {
	187	if (sample & ((uint64_t) 1 << p))
	188	ctx->linebuf[p * ctx->linebuf_len +
	189	ctx->line_offset] = '1';
a1bb33af	190	else
99c1fc59 UH	191	ctx->linebuf[p * ctx->linebuf_len +
99c1fc59 UH	192	ctx->line_offset] = '0';
a1bb33af UH	193	}
	194	ctx->line_offset++;
	195	ctx->spl_cnt++;
	196
99c1fc59 UH	197	/* Add a space every 8th bit. */
	198	if ((ctx->spl_cnt & 7) == 0) {
	199	for (p = 0; p < ctx->num_enabled_probes; p++)
	200	ctx->linebuf[p * ctx->linebuf_len +
	201	ctx->line_offset] = ' ';
a1bb33af UH	202	ctx->line_offset++;
	203	}
	204
99c1fc59 UH	205	/* End of line. */
99c1fc59 UH	206	if (ctx->spl_cnt >= ctx->samples_per_line) {
afc8e4de	207	flush_linebufs(ctx, outbuf);
a1bb33af	208	ctx->line_offset = ctx->spl_cnt = 0;
5045c217	209	ctx->mark_trigger = -1;
a1bb33af UH	210	}
	211	}
	212	} else
99c1fc59	213	g_message("short buffer (length_in=%" PRIu64 ")", length_in);
a1bb33af UH	214
	215	*data_out = outbuf;
	216	*length_out = strlen(outbuf);
	217
	218	return SIGROK_OK;
	219	}
	220
5a8fda15	221	static int init_hex(struct output *o)
a1bb33af	222	{
02076d69	223	return init(o, DEFAULT_BPL_BITS);
a1bb33af UH	224	}
a1bb33af UH	225
99c1fc59 UH	226	static int data_hex(struct output o, char data_in, uint64_t length_in,
99c1fc59 UH	227	char *data_out, uint64_t length_out)
a1bb33af UH	228	{
a1bb33af UH	229	struct context *ctx;
afc8e4de	230	unsigned int outsize, offset, p;
a1bb33af UH	231	uint64_t sample;
	232	char *outbuf;
	233
	234	ctx = o->internal;
99c1fc59 UH	235	outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
	236	ctx->samples_per_line + 512;
	237	outbuf = calloc(1, outsize + 1);
	238	if (ctx->header) {
	239	/* The header is still here, this must be the first packet. */
a1bb33af UH	240	strncpy(outbuf, ctx->header, outsize);
	241	free(ctx->header);
	242	ctx->header = NULL;
99c1fc59	243	} else
a1bb33af UH	244	outbuf[0] = 0;
	245
	246	ctx->line_offset = 0;
99c1fc59 UH	247	for (offset = 0; offset <= length_in - ctx->unitsize;
99c1fc59 UH	248	offset += ctx->unitsize) {
a1bb33af	249	memcpy(&sample, data_in + offset, ctx->unitsize);
99c1fc59	250	for (p = 0; p < ctx->num_enabled_probes; p++) {
a1bb33af	251	ctx->linevalues[p] <<= 1;
99c1fc59 UH	252	if (sample & ((uint64_t) 1 << p))
	253	ctx->linevalues[p] \|= 1;
	254	sprintf(ctx->linebuf + (p * ctx->linebuf_len) +
	255	ctx->line_offset, "%.2x", ctx->linevalues[p]);
a1bb33af UH	256	}
	257	ctx->spl_cnt++;
	258
99c1fc59 UH	259	/* Add a space after every complete hex byte. */
	260	if ((ctx->spl_cnt & 7) == 0) {
	261	for (p = 0; p < ctx->num_enabled_probes; p++)
	262	ctx->linebuf[p * ctx->linebuf_len +
	263	ctx->line_offset + 2] = ' ';
a1bb33af UH	264	ctx->line_offset += 3;
	265	}
	266
99c1fc59 UH	267	/* End of line. */
99c1fc59 UH	268	if (ctx->spl_cnt >= ctx->samples_per_line) {
afc8e4de	269	flush_linebufs(ctx, outbuf);
a1bb33af UH	270	ctx->line_offset = ctx->spl_cnt = 0;
	271	}
	272	}
	273
	274	*data_out = outbuf;
	275	*length_out = strlen(outbuf);
	276
	277	return SIGROK_OK;
	278	}
	279
02076d69	280	struct output_format output_text_bits = {
1c5b9d30 UH	281	"bits",
1c5b9d30 UH	282	"Text (bits)",
02076d69 UH	283	init_bits,
02076d69 UH	284	data_bits,
99c1fc59	285	event,
a1bb33af UH	286	};
a1bb33af UH	287
a1bb33af UH	288	struct output_format output_text_hex = {
	289	"hex",
	290	"Text (hexadecimal)",
	291	init_hex,
	292	data_hex,
99c1fc59	293	event,
a1bb33af	294	};