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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 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 <math.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "output/analog"

#define BIN_TO_DEC_DIGITS (log(2) / log(10))

struct context {
	int num_enabled_channels;
	GPtrArray *channellist;
	int digits;
	float *fdata;
};

enum {
	DIGITS_ALL,
	DIGITS_SPEC,
};

static int init(struct sr_output *o, GHashTable *options)
{
	struct context *ctx;
	struct sr_channel *ch;
	GSList *l;
	const char *s;

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

	o->priv = ctx = g_malloc0(sizeof(struct context));
	s = g_variant_get_string(g_hash_table_lookup(options, "digits"), NULL);
	if (!strcmp(s, "all"))
		ctx->digits = DIGITS_ALL;
	else
		ctx->digits = DIGITS_SPEC;

	/* Get the number of channels and their names. */
	ctx->channellist = g_ptr_array_new();
	for (l = o->sdi->channels; l; l = l->next) {
		ch = l->data;
		if (!ch || !ch->enabled)
			continue;
		g_ptr_array_add(ctx->channellist, ch->name);
		ctx->num_enabled_channels++;
	}
	ctx->fdata = NULL;

	return SR_OK;
}

static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	struct context *ctx;
	const struct sr_datafeed_analog *analog;
	const struct sr_datafeed_meta *meta;
	const struct sr_config *src;
	const struct sr_key_info *srci;
	struct sr_channel *ch;
	GSList *l;
	float *fdata;
	unsigned int i;
	int num_channels, c, ret, digits, actual_digits;
	char *number, *suffix;

	*out = NULL;
	if (!o || !o->sdi)
		return SR_ERR_ARG;
	ctx = o->priv;

	switch (packet->type) {
	case SR_DF_FRAME_BEGIN:
		*out = g_string_new("FRAME-BEGIN\n");
		break;
	case SR_DF_FRAME_END:
		*out = g_string_new("FRAME-END\n");
		break;
	case SR_DF_META:
		meta = packet->payload;
		for (l = meta->config; l; l = l->next) {
			src = l->data;
			if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
				return SR_ERR;
			*out = g_string_sized_new(512);
			g_string_append(*out, "META ");
			g_string_append_printf(*out, "%s: ", srci->id);
			if (srci->datatype == SR_T_BOOL) {
				g_string_append_printf(*out, "%u",
					g_variant_get_boolean(src->data));
			} else if (srci->datatype == SR_T_FLOAT) {
				g_string_append_printf(*out, "%f",
					g_variant_get_double(src->data));
			} else if (srci->datatype == SR_T_UINT64) {
				g_string_append_printf(*out, "%"
					G_GUINT64_FORMAT,
					g_variant_get_uint64(src->data));
			} else if (srci->datatype == SR_T_STRING) {
				g_string_append_printf(*out, "%s",
					g_variant_get_string(src->data, NULL));
			}
			g_string_append(*out, "\n");
		}
		break;
	case SR_DF_ANALOG:
		analog = packet->payload;
		num_channels = g_slist_length(analog->meaning->channels);
		if (!(fdata = g_try_realloc(ctx->fdata,
						analog->num_samples * num_channels * sizeof(float))))
			return SR_ERR_MALLOC;
		ctx->fdata = fdata;
		if ((ret = sr_analog_to_float(analog, fdata)) != SR_OK)
			return ret;
		*out = g_string_sized_new(512);
		if (ctx->digits == DIGITS_ALL)
			digits = analog->encoding->digits;
		else
			digits = analog->spec->spec_digits;
		if (!analog->encoding->is_digits_decimal)
			digits = copysign(ceil(abs(digits) * BIN_TO_DEC_DIGITS), digits);
		gboolean si_friendly = sr_analog_si_prefix_friendly(analog->meaning->unit);
		sr_analog_unit_to_string(analog, &suffix);
		for (i = 0; i < analog->num_samples; i++) {
			for (l = analog->meaning->channels, c = 0; l; l = l->next, c++) {
				float value = fdata[i * num_channels + c];
				const char *prefix = "";
				actual_digits = digits;
				if (si_friendly)
					prefix = sr_analog_si_prefix(&value, &actual_digits);
				ch = l->data;
				g_string_append_printf(*out, "%s: ", ch->name);
				number = g_strdup_printf("%.*f", MAX(actual_digits, 0), value);
				g_string_append(*out, number);
				g_free(number);
				g_string_append(*out, " ");
				g_string_append(*out, prefix);
				g_string_append(*out, suffix);
				g_string_append(*out, "\n");
			}
		}
		g_free(suffix);
		break;
	}

	return SR_OK;
}

static struct sr_option options[] = {
	{ "digits", "Digits", "Digits to show", NULL, NULL },
	ALL_ZERO
};

static const struct sr_option *get_options(void)
{
	if (!options[0].def) {
		options[0].def = g_variant_ref_sink(g_variant_new_string("all"));
		options[0].values = g_slist_append(options[0].values,
				g_variant_ref_sink(g_variant_new_string("all")));
		options[0].values = g_slist_append(options[0].values,
				g_variant_ref_sink(g_variant_new_string("spec")));
	}

	return options;
}

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

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

	g_ptr_array_free(ctx->channellist, 1);
	if (options[0].def) {
		g_variant_unref(options[0].def);
		options[0].def = NULL;
	}
	if (options[0].values) {
		g_slist_free_full(options[0].values, (GDestroyNotify)g_variant_unref);
		options[0].values = NULL;
	}
	g_free(ctx->fdata);
	g_free(ctx);
	o->priv = NULL;

	return SR_OK;
}

SR_PRIV struct sr_output_module output_analog = {
	.id = "analog",
	.name = "Analog",
	.desc = "ASCII analog data values and units",
	.exts = NULL,
	.flags = 0,
	.options = get_options,
	.init = init,
	.receive = receive,
	.cleanup = cleanup
};
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 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 <config.h>
	21	#include <stdlib.h>
	22	#include <string.h>
	23	#include <math.h>
	24	#include <glib.h>
	25	#include <libsigrok/libsigrok.h>
	26	#include "libsigrok-internal.h"
	27
	28	#define LOG_PREFIX "output/analog"
	29
	30	#define BIN_TO_DEC_DIGITS (log(2) / log(10))
	31
	32	struct context {
	33	int num_enabled_channels;
	34	GPtrArray *channellist;
	35	int digits;
	36	float *fdata;
	37	};
	38
	39	enum {
	40	DIGITS_ALL,
	41	DIGITS_SPEC,
	42	};
	43
	44	static int init(struct sr_output o, GHashTable options)
	45	{
	46	struct context *ctx;
	47	struct sr_channel *ch;
	48	GSList *l;
	49	const char *s;
	50
	51	if (!o \|\| !o->sdi)
	52	return SR_ERR_ARG;
	53
	54	o->priv = ctx = g_malloc0(sizeof(struct context));
	55	s = g_variant_get_string(g_hash_table_lookup(options, "digits"), NULL);
	56	if (!strcmp(s, "all"))
	57	ctx->digits = DIGITS_ALL;
	58	else
	59	ctx->digits = DIGITS_SPEC;
	60
	61	/* Get the number of channels and their names. */
	62	ctx->channellist = g_ptr_array_new();
	63	for (l = o->sdi->channels; l; l = l->next) {
	64	ch = l->data;
	65	if (!ch \|\| !ch->enabled)
	66	continue;
	67	g_ptr_array_add(ctx->channellist, ch->name);
	68	ctx->num_enabled_channels++;
	69	}
	70	ctx->fdata = NULL;
	71
	72	return SR_OK;
	73	}
	74
	75	static int receive(const struct sr_output o, const struct sr_datafeed_packet packet,
	76	GString **out)
	77	{
	78	struct context *ctx;
	79	const struct sr_datafeed_analog *analog;
	80	const struct sr_datafeed_meta *meta;
	81	const struct sr_config *src;
	82	const struct sr_key_info *srci;
	83	struct sr_channel *ch;
	84	GSList *l;
	85	float *fdata;
	86	unsigned int i;
	87	int num_channels, c, ret, digits, actual_digits;
	88	char number, suffix;
	89
	90	*out = NULL;
	91	if (!o \|\| !o->sdi)
	92	return SR_ERR_ARG;
	93	ctx = o->priv;
	94
	95	switch (packet->type) {
	96	case SR_DF_FRAME_BEGIN:
	97	*out = g_string_new("FRAME-BEGIN\n");
	98	break;
	99	case SR_DF_FRAME_END:
	100	*out = g_string_new("FRAME-END\n");
	101	break;
	102	case SR_DF_META:
	103	meta = packet->payload;
	104	for (l = meta->config; l; l = l->next) {
	105	src = l->data;
	106	if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
	107	return SR_ERR;
	108	*out = g_string_sized_new(512);
	109	g_string_append(*out, "META ");
	110	g_string_append_printf(*out, "%s: ", srci->id);
	111	if (srci->datatype == SR_T_BOOL) {
	112	g_string_append_printf(*out, "%u",
	113	g_variant_get_boolean(src->data));
	114	} else if (srci->datatype == SR_T_FLOAT) {
	115	g_string_append_printf(*out, "%f",
	116	g_variant_get_double(src->data));
	117	} else if (srci->datatype == SR_T_UINT64) {
	118	g_string_append_printf(*out, "%"
	119	G_GUINT64_FORMAT,
	120	g_variant_get_uint64(src->data));
	121	} else if (srci->datatype == SR_T_STRING) {
	122	g_string_append_printf(*out, "%s",
	123	g_variant_get_string(src->data, NULL));
	124	}
	125	g_string_append(*out, "\n");
	126	}
	127	break;
	128	case SR_DF_ANALOG:
	129	analog = packet->payload;
	130	num_channels = g_slist_length(analog->meaning->channels);
	131	if (!(fdata = g_try_realloc(ctx->fdata,
	132	analog->num_samples * num_channels * sizeof(float))))
	133	return SR_ERR_MALLOC;
	134	ctx->fdata = fdata;
	135	if ((ret = sr_analog_to_float(analog, fdata)) != SR_OK)
	136	return ret;
	137	*out = g_string_sized_new(512);
	138	if (ctx->digits == DIGITS_ALL)
	139	digits = analog->encoding->digits;
	140	else
	141	digits = analog->spec->spec_digits;
	142	if (!analog->encoding->is_digits_decimal)
	143	digits = copysign(ceil(abs(digits) * BIN_TO_DEC_DIGITS), digits);
	144	gboolean si_friendly = sr_analog_si_prefix_friendly(analog->meaning->unit);
	145	sr_analog_unit_to_string(analog, &suffix);
	146	for (i = 0; i < analog->num_samples; i++) {
	147	for (l = analog->meaning->channels, c = 0; l; l = l->next, c++) {
	148	float value = fdata[i * num_channels + c];
	149	const char *prefix = "";
	150	actual_digits = digits;
	151	if (si_friendly)
	152	prefix = sr_analog_si_prefix(&value, &actual_digits);
	153	ch = l->data;
	154	g_string_append_printf(*out, "%s: ", ch->name);
	155	number = g_strdup_printf("%.*f", MAX(actual_digits, 0), value);
	156	g_string_append(*out, number);
	157	g_free(number);
	158	g_string_append(*out, " ");
	159	g_string_append(*out, prefix);
	160	g_string_append(*out, suffix);
	161	g_string_append(*out, "\n");
	162	}
	163	}
	164	g_free(suffix);
	165	break;
	166	}
	167
	168	return SR_OK;
	169	}
	170
	171	static struct sr_option options[] = {
	172	{ "digits", "Digits", "Digits to show", NULL, NULL },
	173	ALL_ZERO
	174	};
	175
	176	static const struct sr_option *get_options(void)
	177	{
	178	if (!options[0].def) {
	179	options[0].def = g_variant_ref_sink(g_variant_new_string("all"));
	180	options[0].values = g_slist_append(options[0].values,
	181	g_variant_ref_sink(g_variant_new_string("all")));
	182	options[0].values = g_slist_append(options[0].values,
	183	g_variant_ref_sink(g_variant_new_string("spec")));
	184	}
	185
	186	return options;
	187	}
	188
	189	static int cleanup(struct sr_output *o)
	190	{
	191	struct context *ctx;
	192
	193	if (!o \|\| !o->sdi)
	194	return SR_ERR_ARG;
	195	ctx = o->priv;
	196
	197	g_ptr_array_free(ctx->channellist, 1);
	198	if (options[0].def) {
	199	g_variant_unref(options[0].def);
	200	options[0].def = NULL;
	201	}
	202	if (options[0].values) {
	203	g_slist_free_full(options[0].values, (GDestroyNotify)g_variant_unref);
	204	options[0].values = NULL;
	205	}
	206	g_free(ctx->fdata);
	207	g_free(ctx);
	208	o->priv = NULL;
	209
	210	return SR_OK;
	211	}
	212
	213	SR_PRIV struct sr_output_module output_analog = {
	214	.id = "analog",
	215	.name = "Analog",
	216	.desc = "ASCII analog data values and units",
	217	.exts = NULL,
	218	.flags = 0,
	219	.options = get_options,
	220	.init = init,
	221	.receive = receive,
	222	.cleanup = cleanup
	223	};