[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;
};

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

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

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

	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:
		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;
			}
		}
	} 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;
	40	};
	41
afc8e4de	42	static void flush_linebufs(struct context ctx, char outbuf)
a1bb33af UH	43	{
	44	static int max_probename_len = 0;
	45	int len, i;
	46
99c1fc59	47	if (ctx->linebuf[0] == 0)
a1bb33af UH	48	return;
a1bb33af UH	49
99c1fc59 UH	50	if (max_probename_len == 0) {
	51	/* First time through... */
	52	for (i = 0; ctx->probelist[i]; i++) {
a1bb33af	53	len = strlen(ctx->probelist[i]);
99c1fc59	54	if (len > max_probename_len)
a1bb33af UH	55	max_probename_len = len;
	56	}
	57	}
	58
99c1fc59 UH	59	for (i = 0; ctx->probelist[i]; i++) {
	60	sprintf(outbuf + strlen(outbuf), "%*s:%s\n", max_probename_len,
	61	ctx->probelist[i], ctx->linebuf + i * ctx->linebuf_len);
a1bb33af UH	62	}
a1bb33af UH	63	memset(ctx->linebuf, 0, i * ctx->linebuf_len);
a1bb33af UH	64	}
a1bb33af UH	65
5a8fda15	66	static int init(struct output *o, int default_spl)
a1bb33af UH	67	{
	68	struct context *ctx;
	69	struct probe *probe;
	70	GSList *l;
	71	uint64_t samplerate;
	72	int num_probes;
25e7d9b1	73	char *samplerate_s;
a1bb33af UH	74
	75	ctx = malloc(sizeof(struct context));
	76	o->internal = ctx;
	77	ctx->num_enabled_probes = 0;
99c1fc59 UH	78
99c1fc59 UH	79	for (l = o->device->probes; l; l = l->next) {
a1bb33af	80	probe = l->data;
99c1fc59	81	if (probe->enabled)
a1bb33af UH	82	ctx->probelist[ctx->num_enabled_probes++] = probe->name;
a1bb33af UH	83	}
99c1fc59	84
a1bb33af UH	85	ctx->probelist[ctx->num_enabled_probes] = 0;
	86	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
	87	ctx->line_offset = 0;
	88	ctx->spl_cnt = 0;
99c1fc59 UH	89
99c1fc59 UH	90	if (o->param && o->param[0])
a1bb33af UH	91	ctx->samples_per_line = strtoul(o->param, NULL, 10);
	92	else
	93	ctx->samples_per_line = default_spl;
	94
	95	ctx->header = malloc(512);
	96	num_probes = g_slist_length(o->device->probes);
99c1fc59 UH	97	samplerate = ((uint64_t ) o->device->plugin->get_device_info(
	98	o->device->plugin_index, DI_CUR_SAMPLERATE));
	99	snprintf(ctx->header, 512, "Acquisition with %d/%d probes at ",
	100	ctx->num_enabled_probes, num_probes);
25e7d9b1 UH	101
25e7d9b1 UH	102	if ((samplerate_s = sigrok_samplerate_string(samplerate)) == NULL)
99c1fc59	103	return -1; /* FIXME */
25e7d9b1 UH	104	snprintf(ctx->header + strlen(ctx->header), 512, "%s\n", samplerate_s);
25e7d9b1 UH	105	free(samplerate_s);
a1bb33af UH	106
	107	ctx->linebuf_len = ctx->samples_per_line * 2;
	108	ctx->linebuf = calloc(1, num_probes * ctx->linebuf_len);
	109	ctx->linevalues = calloc(1, num_probes);
	110
5a8fda15	111	return 0;
a1bb33af UH	112	}
a1bb33af UH	113
99c1fc59 UH	114	static int event(struct output o, int event_type, char *data_out,
99c1fc59 UH	115	uint64_t *length_out)
a1bb33af UH	116	{
	117	struct context *ctx;
	118	int outsize;
	119	char *outbuf;
	120
	121	ctx = o->internal;
99c1fc59	122	switch (event_type) {
a1bb33af UH	123	case DF_TRIGGER:
	124	break;
	125	case DF_END:
99c1fc59 UH	126	outsize = ctx->num_enabled_probes
99c1fc59 UH	127	* (ctx->samples_per_line + 20) + 512;
a1bb33af	128	outbuf = calloc(1, outsize);
afc8e4de	129	flush_linebufs(ctx, outbuf);
a1bb33af UH	130	*data_out = outbuf;
	131	*length_out = strlen(outbuf);
	132	free(o->internal);
	133	o->internal = NULL;
	134	break;
	135	}
	136
	137	return SIGROK_OK;
	138	}
	139
02076d69	140	static int init_bits(struct output *o)
a1bb33af	141	{
02076d69	142	return init(o, DEFAULT_BPL_BITS);
a1bb33af UH	143	}
a1bb33af UH	144
99c1fc59 UH	145	static int data_bits(struct output o, char data_in, uint64_t length_in,
99c1fc59 UH	146	char *data_out, uint64_t length_out)
a1bb33af UH	147	{
a1bb33af UH	148	struct context *ctx;
afc8e4de	149	unsigned int outsize, offset, p;
a1bb33af UH	150	uint64_t sample;
	151	char *outbuf;
	152
	153	ctx = o->internal;
99c1fc59 UH	154	outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
	155	ctx->samples_per_line + 512;
	156	outbuf = calloc(1, outsize + 1);
	157	if (ctx->header) {
	158	/* The header is still here, this must be the first packet. */
a1bb33af UH	159	strncpy(outbuf, ctx->header, outsize);
	160	free(ctx->header);
	161	ctx->header = NULL;
99c1fc59	162	} else
a1bb33af UH	163	outbuf[0] = 0;
a1bb33af UH	164
99c1fc59 UH	165	if (length_in >= ctx->unitsize) {
	166	for (offset = 0; offset <= length_in - ctx->unitsize;
	167	offset += ctx->unitsize) {
a1bb33af	168	memcpy(&sample, data_in + offset, ctx->unitsize);
99c1fc59 UH	169	for (p = 0; p < ctx->num_enabled_probes; p++) {
	170	if (sample & ((uint64_t) 1 << p))
	171	ctx->linebuf[p * ctx->linebuf_len +
	172	ctx->line_offset] = '1';
a1bb33af	173	else
99c1fc59 UH	174	ctx->linebuf[p * ctx->linebuf_len +
99c1fc59 UH	175	ctx->line_offset] = '0';
a1bb33af UH	176	}
	177	ctx->line_offset++;
	178	ctx->spl_cnt++;
	179
99c1fc59 UH	180	/* Add a space every 8th bit. */
	181	if ((ctx->spl_cnt & 7) == 0) {
	182	for (p = 0; p < ctx->num_enabled_probes; p++)
	183	ctx->linebuf[p * ctx->linebuf_len +
	184	ctx->line_offset] = ' ';
a1bb33af UH	185	ctx->line_offset++;
	186	}
	187
99c1fc59 UH	188	/* End of line. */
99c1fc59 UH	189	if (ctx->spl_cnt >= ctx->samples_per_line) {
afc8e4de	190	flush_linebufs(ctx, outbuf);
a1bb33af UH	191	ctx->line_offset = ctx->spl_cnt = 0;
	192	}
	193	}
	194	} else
99c1fc59	195	g_message("short buffer (length_in=%" PRIu64 ")", length_in);
a1bb33af UH	196
	197	*data_out = outbuf;
	198	*length_out = strlen(outbuf);
	199
	200	return SIGROK_OK;
	201	}
	202
5a8fda15	203	static int init_hex(struct output *o)
a1bb33af	204	{
02076d69	205	return init(o, DEFAULT_BPL_BITS);
a1bb33af UH	206	}
a1bb33af UH	207
99c1fc59 UH	208	static int data_hex(struct output o, char data_in, uint64_t length_in,
99c1fc59 UH	209	char *data_out, uint64_t length_out)
a1bb33af UH	210	{
a1bb33af UH	211	struct context *ctx;
afc8e4de	212	unsigned int outsize, offset, p;
a1bb33af UH	213	uint64_t sample;
	214	char *outbuf;
	215
	216	ctx = o->internal;
99c1fc59 UH	217	outsize = length_in / ctx->unitsize * ctx->num_enabled_probes *
	218	ctx->samples_per_line + 512;
	219	outbuf = calloc(1, outsize + 1);
	220	if (ctx->header) {
	221	/* The header is still here, this must be the first packet. */
a1bb33af UH	222	strncpy(outbuf, ctx->header, outsize);
	223	free(ctx->header);
	224	ctx->header = NULL;
99c1fc59	225	} else
a1bb33af UH	226	outbuf[0] = 0;
	227
	228	ctx->line_offset = 0;
99c1fc59 UH	229	for (offset = 0; offset <= length_in - ctx->unitsize;
99c1fc59 UH	230	offset += ctx->unitsize) {
a1bb33af	231	memcpy(&sample, data_in + offset, ctx->unitsize);
99c1fc59	232	for (p = 0; p < ctx->num_enabled_probes; p++) {
a1bb33af	233	ctx->linevalues[p] <<= 1;
99c1fc59 UH	234	if (sample & ((uint64_t) 1 << p))
	235	ctx->linevalues[p] \|= 1;
	236	sprintf(ctx->linebuf + (p * ctx->linebuf_len) +
	237	ctx->line_offset, "%.2x", ctx->linevalues[p]);
a1bb33af UH	238	}
	239	ctx->spl_cnt++;
	240
99c1fc59 UH	241	/* Add a space after every complete hex byte. */
	242	if ((ctx->spl_cnt & 7) == 0) {
	243	for (p = 0; p < ctx->num_enabled_probes; p++)
	244	ctx->linebuf[p * ctx->linebuf_len +
	245	ctx->line_offset + 2] = ' ';
a1bb33af UH	246	ctx->line_offset += 3;
	247	}
	248
99c1fc59 UH	249	/* End of line. */
99c1fc59 UH	250	if (ctx->spl_cnt >= ctx->samples_per_line) {
afc8e4de	251	flush_linebufs(ctx, outbuf);
a1bb33af UH	252	ctx->line_offset = ctx->spl_cnt = 0;
	253	}
	254	}
	255
	256	*data_out = outbuf;
	257	*length_out = strlen(outbuf);
	258
	259	return SIGROK_OK;
	260	}
	261
02076d69	262	struct output_format output_text_bits = {
1c5b9d30 UH	263	"bits",
1c5b9d30 UH	264	"Text (bits)",
02076d69 UH	265	init_bits,
02076d69 UH	266	data_bits,
99c1fc59	267	event,
a1bb33af UH	268	};
a1bb33af UH	269
a1bb33af UH	270	struct output_format output_text_hex = {
	271	"hex",
	272	"Text (hexadecimal)",
	273	init_hex,
	274	data_hex,
99c1fc59	275	event,
a1bb33af	276	};