BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
libsigrok/output/analog.c

265 lines
6.8 KiB
C
Raw Normal View History

sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
/*
GPL headers: Use correct project name.
2013-04-23 20:24:30 +00:00
* This file is part of the libsigrok project.
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
*
* 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>
Output modules: Use message logging helpers.
2012-11-11 08:36:21 +00:00
#include <math.h>
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
Output modules: Use message logging helpers.
2012-11-11 08:36:21 +00:00
s/DRIVER_LOG_DOMAIN/LOG_PREFIX/. This is more correct anyway, and also a bit shorter and more readable.
2013-05-03 19:59:32 +00:00
/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "output/analog: "
#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
struct context {
int num_enabled_probes;
GPtrArray *probelist;
};
static int init(struct sr_output *o)
{
struct context *ctx;
struct sr_probe *probe;
GSList *l;
Output modules: Use message logging helpers.
2012-11-11 08:36:21 +00:00
sr_spew("Initializing output module.");
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
if (!o || !o->sdi)
return SR_ERR_ARG;
Return SR_ERR_MALLOC upon allocation errors. Add some TODOs.
2012-10-30 19:20:22 +00:00
if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
Output modules: Use message logging helpers.
2012-11-11 08:36:21 +00:00
sr_err("Output module context malloc failed.");
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
return SR_ERR_MALLOC;
Return SR_ERR_MALLOC upon allocation errors. Add some TODOs.
2012-10-30 19:20:22 +00:00
}
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
o->internal = ctx;
/* Get the number of probes and their names. */
ctx->probelist = g_ptr_array_new();
for (l = o->sdi->probes; l; l = l->next) {
probe = l->data;
if (!probe || !probe->enabled)
continue;
g_ptr_array_add(ctx->probelist, probe->name);
ctx->num_enabled_probes++;
}
return SR_OK;
}
static void si_printf(float value, GString *out, char *unitstr)
{
analog: sane printing of very small and negative values
2012-10-16 12:03:40 +00:00
float v;
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
analog: sane printing of very small and negative values
2012-10-16 12:03:40 +00:00
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);
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
else
g_string_append_printf(out, "%f %s", value, unitstr);
}
static void fancyprint(int unit, int mqflags, float value, GString *out)
{
switch (unit) {
Minor whitespace fixes.
2013-05-03 12:03:49 +00:00
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;
default:
si_printf(value, out, "");
break;
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
}
output/analog: Support all known MQFLAGs.
2013-08-30 06:57:09 +00:00
if (mqflags & SR_MQFLAG_AC)
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
g_string_append_printf(out, " AC");
output/analog: Support all known MQFLAGs.
2013-08-30 06:57:09 +00:00
if (mqflags & SR_MQFLAG_DC)
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
g_string_append_printf(out, " DC");
output/analog: Support all known MQFLAGs.
2013-08-30 06:57:09 +00:00
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");
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
g_string_append_c(out, '\n');
}
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
static int receive(struct sr_output *o, const struct sr_dev_inst *sdi,
const struct sr_datafeed_packet *packet, GString **out)
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
{
Always interleave analog data with all enabled probes. The new "probes" field in sr_datafeed_analog contains a copy of all enabled struct sr_probe.
2013-01-23 02:40:44 +00:00
const struct sr_datafeed_analog *analog;
struct sr_probe *probe;
GSList *l;
Pass sr_datafeed_packets and payloads with const pointers This patch marks packet structures and their payloads as const. This indicates to packet receivers that modifications to these are not allowed. In general all pointers should be marked const unless modification of the referenced data is explicitly allowed.
2012-12-13 21:07:53 +00:00
const float *fdata;
Always interleave analog data with all enabled probes. The new "probes" field in sr_datafeed_analog contains a copy of all enabled struct sr_probe.
2013-01-23 02:40:44 +00:00
int i, p;
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
analog: add pretty-printer for dBu and dBV
2012-10-16 21:31:18 +00:00
(void)sdi;
All drivers: Drop unneeded comments.
2012-11-11 08:30:42 +00:00
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
*out = NULL;
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
if (!o || !o->sdi)
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
return SR_ERR_ARG;
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
switch (packet->type) {
case SR_DF_FRAME_BEGIN:
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
*out = g_string_new("FRAME-BEGIN\n");
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
break;
case SR_DF_FRAME_END:
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
*out = g_string_new("FRAME-END\n");
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
break;
case SR_DF_ANALOG:
analog = packet->payload;
Pass sr_datafeed_packets and payloads with const pointers This patch marks packet structures and their payloads as const. This indicates to packet receivers that modifications to these are not allowed. In general all pointers should be marked const unless modification of the referenced data is explicitly allowed.
2012-12-13 21:07:53 +00:00
fdata = (const float *)analog->data;
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
*out = g_string_sized_new(512);
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
for (i = 0; i < analog->num_samples; i++) {
Always interleave analog data with all enabled probes. The new "probes" field in sr_datafeed_analog contains a copy of all enabled struct sr_probe.
2013-01-23 02:40:44 +00:00
for (l = analog->probes, p = 0; l; l = l->next, p++) {
probe = l->data;
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
g_string_append_printf(*out, "%s: ", probe->name);
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
fancyprint(analog->unit, analog->mqflags,
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
fdata[i + p], *out);
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
}
}
break;
}
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
return SR_OK;
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
}
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->probelist, 1);
g_free(ctx);
o->internal = NULL;
return SR_OK;
}
SR_PRIV struct sr_output_format output_analog = {
.id = "analog",
.description = "Analog data",
.df_type = SR_DF_ANALOG,
.init = init,
Fix output API receive() function This changes the new output API's recv() to receive(), and has it return an integer status code. The output of the function, if any, is stored in a new parameter as a pointer to a newly allocated GString. All output modules using this API have been adjusted.
2013-04-27 15:29:46 +00:00
.receive = receive,
sr: add new analog output module This outputs text representation of SR_DF_ANALOG packets. Unlike the float module however, it also outputs the standard abbreviations of SI units corresponding to the packet's MQ and unit. It also makes an effort to multiply or divide the floating point value as needed to the nearest multiple or fraction, and inserts the appropriate SI prefix to match.
2012-09-08 11:24:48 +00:00
.cleanup = cleanup
};