[libsigrok.git] / 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 <stdlib.h>
#include <string.h>
#include <math.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

#define LOG_PREFIX "output/analog"

struct context {
	int num_enabled_channels;
	GPtrArray *channellist;
};

static int init(struct sr_output *o)
{
	struct context *ctx;
	struct sr_channel *ch;
	GSList *l;

	sr_spew("Initializing output module.");

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

	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
		sr_err("Output module context malloc failed.");
		return SR_ERR_MALLOC;
	}
	o->internal = ctx;

	/* 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++;
	}

	return SR_OK;
}

static void si_printf(float value, GString *out, char *unitstr)
{
	float v;

	if (signbit(value))
		v = -(value);
	else
		v = value;

	if (v < 1e-12 || v > 1e+12)
		g_string_append_printf(out, "%f %s", value, unitstr);
	else if (v > 1e+9)
		g_string_append_printf(out, "%f G%s", value / 1e+9, unitstr);
	else if (v > 1e+6)
		g_string_append_printf(out, "%f M%s", value / 1e+6, unitstr);
	else if (v > 1e+3)
		g_string_append_printf(out, "%f k%s", value / 1e+3, unitstr);
	else if (v < 1e-9)
		g_string_append_printf(out, "%f n%s", value * 1e+9, unitstr);
	else if (v < 1e-6)
		g_string_append_printf(out, "%f u%s", value * 1e+6, unitstr);
	else if (v < 1e-3)
		g_string_append_printf(out, "%f m%s", value * 1e+3, unitstr);
	else
		g_string_append_printf(out, "%f %s", value, unitstr);

}

static void fancyprint(int unit, int mqflags, float value, GString *out)
{
	switch (unit) {
	case SR_UNIT_VOLT:
		si_printf(value, out, "V");
		break;
	case SR_UNIT_AMPERE:
		si_printf(value, out, "A");
		break;
	case SR_UNIT_OHM:
		si_printf(value, out, "");
		g_string_append_unichar(out, 0x2126);
		break;
	case SR_UNIT_FARAD:
		si_printf(value, out, "F");
		break;
	case SR_UNIT_KELVIN:
		si_printf(value, out, "K");
		break;
	case SR_UNIT_CELSIUS:
		si_printf(value, out, "");
		g_string_append_unichar(out, 0x00b0);
		g_string_append_c(out, 'C');
		break;
	case SR_UNIT_FAHRENHEIT:
		si_printf(value, out, "");
		g_string_append_unichar(out, 0x00b0);
		g_string_append_c(out, 'F');
		break;
	case SR_UNIT_HERTZ:
		si_printf(value, out, "Hz");
		break;
	case SR_UNIT_PERCENTAGE:
		g_string_append_printf(out, "%f %%", value);
		break;
	case SR_UNIT_BOOLEAN:
		if (value > 0)
			g_string_append_printf(out, "TRUE");
		else
			g_string_append_printf(out, "FALSE");
		break;
	case SR_UNIT_SECOND:
		si_printf(value, out, "s");
		break;
	case SR_UNIT_SIEMENS:
		si_printf(value, out, "S");
		break;
	case SR_UNIT_DECIBEL_MW:
		si_printf(value, out, "dBu");
		break;
	case SR_UNIT_DECIBEL_VOLT:
		si_printf(value, out, "dBV");
		break;
	case SR_UNIT_DECIBEL_SPL:
		if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
			si_printf(value, out, "dB(A)");
		else if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_C)
			si_printf(value, out, "dB(C)");
		else if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_Z)
			si_printf(value, out, "dB(Z)");
		else
			/* No frequency weighting, or non-standard "flat" */
			si_printf(value, out, "dB(SPL)");
		if (mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_S)
			g_string_append(out, " S");
		else if (mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
			g_string_append(out, " F");
		if (mqflags & SR_MQFLAG_SPL_LAT)
			g_string_append(out, " LAT");
		else if (mqflags & SR_MQFLAG_SPL_PCT_OVER_ALARM)
			/* Not a standard function for SLMs, so this is
			 * a made-up notation. */
			g_string_append(out, " %oA");
		break;
	case SR_UNIT_CONCENTRATION:
		g_string_append_printf(out, "%f ppm", value * 1000000);
		break;
	case SR_UNIT_REVOLUTIONS_PER_MINUTE:
		si_printf(value, out, "RPM");
		break;
	case SR_UNIT_VOLT_AMPERE:
		si_printf(value, out, "VA");
		break;
	case SR_UNIT_WATT:
		si_printf(value, out, "W");
		break;
	case SR_UNIT_WATT_HOUR:
		si_printf(value, out, "Wh");
		break;
	case SR_UNIT_METER_SECOND:
		si_printf(value, out, "m/s");
		break;
	case SR_UNIT_HECTOPASCAL:
		si_printf(value, out, "hPa");
		break;
	case SR_UNIT_HUMIDITY_293K:
		si_printf(value, out, "%rF");
		break;
	default:
		si_printf(value, out, "");
		break;
	}

	if (mqflags & SR_MQFLAG_AC)
		g_string_append_printf(out, " AC");
	if (mqflags & SR_MQFLAG_DC)
		g_string_append_printf(out, " DC");
	if (mqflags & SR_MQFLAG_RMS)
		g_string_append_printf(out, " RMS");
	if (mqflags & SR_MQFLAG_DIODE)
		g_string_append_printf(out, " DIODE");
	if (mqflags & SR_MQFLAG_HOLD)
		g_string_append_printf(out, " HOLD");
	if (mqflags & SR_MQFLAG_MAX)
		g_string_append_printf(out, " MAX");
	if (mqflags & SR_MQFLAG_MIN)
		g_string_append_printf(out, " MIN");
	if (mqflags & SR_MQFLAG_AUTORANGE)
		g_string_append_printf(out, " AUTO");
	if (mqflags & SR_MQFLAG_RELATIVE)
		g_string_append_printf(out, " REL");
	if (mqflags & SR_MQFLAG_AVG)
		g_string_append_printf(out, " AVG");
	g_string_append_c(out, '\n');
}

static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
		GString **out)
{
	const struct sr_datafeed_analog *analog;
	struct sr_channel *ch;
	GSList *l;
	const float *fdata;
	int i, p;

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

	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_ANALOG:
		analog = packet->payload;
		fdata = (const float *)analog->data;
		*out = g_string_sized_new(512);
		for (i = 0; i < analog->num_samples; i++) {
			for (l = analog->channels, p = 0; l; l = l->next, p++) {
				ch = l->data;
				g_string_append_printf(*out, "%s: ", ch->name);
				fancyprint(analog->unit, analog->mqflags,
						fdata[i + p], *out);
			}
		}
		break;
	}

	return SR_OK;
}

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

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

	g_ptr_array_free(ctx->channellist, 1);
	g_free(ctx);
	o->internal = NULL;

	return SR_OK;
}

SR_PRIV struct sr_output_format output_analog = {
	.id = "analog",
	.description = "Analog data",
	.init = init,
	.receive = receive,
	.cleanup = cleanup
};
Commit	Line	Data
161a8a27	1	/*
50985c20	2	* This file is part of the libsigrok project.
161a8a27 BV	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 <stdlib.h>
	21	#include <string.h>
a944a84b	22	#include <math.h>
161a8a27	23	#include <glib.h>
161a8a27 BV	24	#include "libsigrok.h"
161a8a27 BV	25	#include "libsigrok-internal.h"
a944a84b	26
3544f848	27	#define LOG_PREFIX "output/analog"
161a8a27 BV	28
161a8a27 BV	29	struct context {
ba7dd8bb UH	30	int num_enabled_channels;
ba7dd8bb UH	31	GPtrArray *channellist;
161a8a27 BV	32	};
161a8a27 BV	33
161a8a27 BV	34	static int init(struct sr_output *o)
	35	{
	36	struct context *ctx;
ba7dd8bb	37	struct sr_channel *ch;
161a8a27 BV	38	GSList *l;
161a8a27 BV	39
a944a84b UH	40	sr_spew("Initializing output module.");
a944a84b UH	41
161a8a27 BV	42	if (!o \|\| !o->sdi)
	43	return SR_ERR_ARG;
	44
886a52b6	45	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
a944a84b	46	sr_err("Output module context malloc failed.");
161a8a27	47	return SR_ERR_MALLOC;
886a52b6	48	}
161a8a27 BV	49	o->internal = ctx;
161a8a27 BV	50
ba7dd8bb UH	51	/* Get the number of channels and their names. */
	52	ctx->channellist = g_ptr_array_new();
	53	for (l = o->sdi->channels; l; l = l->next) {
	54	ch = l->data;
	55	if (!ch \|\| !ch->enabled)
161a8a27	56	continue;
ba7dd8bb UH	57	g_ptr_array_add(ctx->channellist, ch->name);
ba7dd8bb UH	58	ctx->num_enabled_channels++;
161a8a27 BV	59	}
161a8a27 BV	60
161a8a27 BV	61	return SR_OK;
	62	}
	63
	64	static void si_printf(float value, GString out, char unitstr)
	65	{
d713e561	66	float v;
161a8a27	67
d713e561 BV	68	if (signbit(value))
	69	v = -(value);
	70	else
	71	v = value;
	72
	73	if (v < 1e-12 \|\| v > 1e+12)
	74	g_string_append_printf(out, "%f %s", value, unitstr);
	75	else if (v > 1e+9)
	76	g_string_append_printf(out, "%f G%s", value / 1e+9, unitstr);
	77	else if (v > 1e+6)
	78	g_string_append_printf(out, "%f M%s", value / 1e+6, unitstr);
	79	else if (v > 1e+3)
	80	g_string_append_printf(out, "%f k%s", value / 1e+3, unitstr);
	81	else if (v < 1e-9)
	82	g_string_append_printf(out, "%f n%s", value * 1e+9, unitstr);
	83	else if (v < 1e-6)
	84	g_string_append_printf(out, "%f u%s", value * 1e+6, unitstr);
	85	else if (v < 1e-3)
	86	g_string_append_printf(out, "%f m%s", value * 1e+3, unitstr);
161a8a27 BV	87	else
	88	g_string_append_printf(out, "%f %s", value, unitstr);
	89
	90	}
	91
	92	static void fancyprint(int unit, int mqflags, float value, GString *out)
	93	{
161a8a27	94	switch (unit) {
06c45a66 UH	95	case SR_UNIT_VOLT:
	96	si_printf(value, out, "V");
	97	break;
	98	case SR_UNIT_AMPERE:
	99	si_printf(value, out, "A");
	100	break;
	101	case SR_UNIT_OHM:
	102	si_printf(value, out, "");
	103	g_string_append_unichar(out, 0x2126);
	104	break;
	105	case SR_UNIT_FARAD:
	106	si_printf(value, out, "F");
	107	break;
	108	case SR_UNIT_KELVIN:
	109	si_printf(value, out, "K");
	110	break;
	111	case SR_UNIT_CELSIUS:
	112	si_printf(value, out, "");
	113	g_string_append_unichar(out, 0x00b0);
	114	g_string_append_c(out, 'C');
	115	break;
	116	case SR_UNIT_FAHRENHEIT:
	117	si_printf(value, out, "");
	118	g_string_append_unichar(out, 0x00b0);
	119	g_string_append_c(out, 'F');
	120	break;
	121	case SR_UNIT_HERTZ:
	122	si_printf(value, out, "Hz");
	123	break;
	124	case SR_UNIT_PERCENTAGE:
641d8f27	125	g_string_append_printf(out, "%f %%", value);
06c45a66 UH	126	break;
	127	case SR_UNIT_BOOLEAN:
	128	if (value > 0)
	129	g_string_append_printf(out, "TRUE");
	130	else
	131	g_string_append_printf(out, "FALSE");
	132	break;
	133	case SR_UNIT_SECOND:
	134	si_printf(value, out, "s");
	135	break;
	136	case SR_UNIT_SIEMENS:
	137	si_printf(value, out, "S");
	138	break;
	139	case SR_UNIT_DECIBEL_MW:
	140	si_printf(value, out, "dBu");
	141	break;
	142	case SR_UNIT_DECIBEL_VOLT:
	143	si_printf(value, out, "dBV");
	144	break;
	145	case SR_UNIT_DECIBEL_SPL:
	146	if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
	147	si_printf(value, out, "dB(A)");
	148	else if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_C)
	149	si_printf(value, out, "dB(C)");
	150	else if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_Z)
	151	si_printf(value, out, "dB(Z)");
	152	else
	153	/* No frequency weighting, or non-standard "flat" */
	154	si_printf(value, out, "dB(SPL)");
	155	if (mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_S)
	156	g_string_append(out, " S");
	157	else if (mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
	158	g_string_append(out, " F");
	159	if (mqflags & SR_MQFLAG_SPL_LAT)
	160	g_string_append(out, " LAT");
	161	else if (mqflags & SR_MQFLAG_SPL_PCT_OVER_ALARM)
	162	/* Not a standard function for SLMs, so this is
	163	* a made-up notation. */
	164	g_string_append(out, " %oA");
	165	break;
	166	case SR_UNIT_CONCENTRATION:
	167	g_string_append_printf(out, "%f ppm", value * 1000000);
	168	break;
87532f23 AJ	169	case SR_UNIT_REVOLUTIONS_PER_MINUTE:
87532f23 AJ	170	si_printf(value, out, "RPM");
d69d2642	171	break;
45315d04 AJ	172	case SR_UNIT_VOLT_AMPERE:
	173	si_printf(value, out, "VA");
	174	break;
	175	case SR_UNIT_WATT:
	176	si_printf(value, out, "W");
	177	break;
	178	case SR_UNIT_WATT_HOUR:
	179	si_printf(value, out, "Wh");
87532f23	180	break;
543d041d BV	181	case SR_UNIT_METER_SECOND:
	182	si_printf(value, out, "m/s");
	183	break;
	184	case SR_UNIT_HECTOPASCAL:
	185	si_printf(value, out, "hPa");
	186	break;
	187	case SR_UNIT_HUMIDITY_293K:
	188	si_printf(value, out, "%rF");
	189	break;
06c45a66 UH	190	default:
	191	si_printf(value, out, "");
	192	break;
161a8a27	193	}
e6523173 UH	194
e6523173 UH	195	if (mqflags & SR_MQFLAG_AC)
161a8a27	196	g_string_append_printf(out, " AC");
e6523173	197	if (mqflags & SR_MQFLAG_DC)
161a8a27	198	g_string_append_printf(out, " DC");
e6523173 UH	199	if (mqflags & SR_MQFLAG_RMS)
	200	g_string_append_printf(out, " RMS");
	201	if (mqflags & SR_MQFLAG_DIODE)
	202	g_string_append_printf(out, " DIODE");
	203	if (mqflags & SR_MQFLAG_HOLD)
	204	g_string_append_printf(out, " HOLD");
	205	if (mqflags & SR_MQFLAG_MAX)
	206	g_string_append_printf(out, " MAX");
	207	if (mqflags & SR_MQFLAG_MIN)
	208	g_string_append_printf(out, " MIN");
	209	if (mqflags & SR_MQFLAG_AUTORANGE)
	210	g_string_append_printf(out, " AUTO");
	211	if (mqflags & SR_MQFLAG_RELATIVE)
	212	g_string_append_printf(out, " REL");
f5027ca4 AJ	213	if (mqflags & SR_MQFLAG_AVG)
f5027ca4 AJ	214	g_string_append_printf(out, " AVG");
161a8a27	215	g_string_append_c(out, '\n');
161a8a27 BV	216	}
161a8a27 BV	217
dba3e682 BV	218	static int receive(struct sr_output o, const struct sr_datafeed_packet packet,
dba3e682 BV	219	GString **out)
161a8a27	220	{
69e19dd7	221	const struct sr_datafeed_analog *analog;
ba7dd8bb	222	struct sr_channel *ch;
69e19dd7	223	GSList *l;
bf53457d	224	const float *fdata;
69e19dd7	225	int i, p;
161a8a27	226
17f63de6	227	*out = NULL;
161a8a27	228	if (!o \|\| !o->sdi)
17f63de6	229	return SR_ERR_ARG;
161a8a27	230
161a8a27	231	switch (packet->type) {
161a8a27	232	case SR_DF_FRAME_BEGIN:
17f63de6	233	*out = g_string_new("FRAME-BEGIN\n");
161a8a27 BV	234	break;
161a8a27 BV	235	case SR_DF_FRAME_END:
17f63de6	236	*out = g_string_new("FRAME-END\n");
161a8a27 BV	237	break;
	238	case SR_DF_ANALOG:
	239	analog = packet->payload;
bf53457d	240	fdata = (const float *)analog->data;
17f63de6	241	*out = g_string_sized_new(512);
161a8a27	242	for (i = 0; i < analog->num_samples; i++) {
ba7dd8bb UH	243	for (l = analog->channels, p = 0; l; l = l->next, p++) {
	244	ch = l->data;
	245	g_string_append_printf(*out, "%s: ", ch->name);
161a8a27	246	fancyprint(analog->unit, analog->mqflags,
17f63de6	247	fdata[i + p], *out);
161a8a27 BV	248	}
	249	}
	250	break;
	251	}
	252
17f63de6	253	return SR_OK;
161a8a27 BV	254	}
	255
	256	static int cleanup(struct sr_output *o)
	257	{
	258	struct context *ctx;
	259
	260	if (!o \|\| !o->sdi)
	261	return SR_ERR_ARG;
	262	ctx = o->internal;
	263
ba7dd8bb	264	g_ptr_array_free(ctx->channellist, 1);
161a8a27 BV	265	g_free(ctx);
	266	o->internal = NULL;
	267
	268	return SR_OK;
	269	}
	270
161a8a27 BV	271	SR_PRIV struct sr_output_format output_analog = {
	272	.id = "analog",
	273	.description = "Analog data",
161a8a27	274	.init = init,
17f63de6	275	.receive = receive,
161a8a27 BV	276	.cleanup = cleanup
161a8a27 BV	277	};