X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fanalog.c;h=da1560cd6702b91b66ae010b8263e84b30cebbcb;hb=88a0265ebcb265ba839c02cc5bcd39e359c9f60f;hp=9def3ac8fa62347f405d2acabf2d59b98c6eb4e8;hpb=4b4fdeea947950725b704a7af65b166e46521882;p=libsigrok.git diff --git a/src/analog.c b/src/analog.c index 9def3ac8..da1560cd 100644 --- a/src/analog.c +++ b/src/analog.c @@ -17,13 +17,108 @@ * along with this program. If not, see . */ +#include +#include +#include #include -#include "libsigrok.h" +#include +#include #include "libsigrok-internal.h" +/** @cond PRIVATE */ #define LOG_PREFIX "analog" +/** @endcond */ -SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog, +/** + * @file + * + * Handling and converting analog data. + */ + +/** + * @defgroup grp_analog Analog data handling + * + * Handling and converting analog data. + * + * @{ + */ + +struct unit_mq_string { + uint64_t value; + const char *str; +}; + +/* Please use the same order as in enum sr_unit (libsigrok.h). */ +static struct unit_mq_string unit_strings[] = { + { SR_UNIT_VOLT, "V" }, + { SR_UNIT_AMPERE, "A" }, + { SR_UNIT_OHM, "\xe2\x84\xa6" }, + { SR_UNIT_FARAD, "F" }, + { SR_UNIT_KELVIN, "K" }, + { SR_UNIT_CELSIUS, "\xc2\xb0""C" }, + { SR_UNIT_FAHRENHEIT, "\xc2\xb0""F" }, + { SR_UNIT_HERTZ, "Hz" }, + { SR_UNIT_PERCENTAGE, "%" }, + { SR_UNIT_BOOLEAN, "" }, + { SR_UNIT_SECOND, "s" }, + { SR_UNIT_SIEMENS, "S" }, + { SR_UNIT_DECIBEL_MW, "dBu" }, + { SR_UNIT_DECIBEL_VOLT, "dBv" }, + { SR_UNIT_UNITLESS, "" }, + { SR_UNIT_DECIBEL_SPL, "dB" }, + { SR_UNIT_CONCENTRATION, "ppm" }, + { SR_UNIT_REVOLUTIONS_PER_MINUTE, "RPM" }, + { SR_UNIT_VOLT_AMPERE, "VA" }, + { SR_UNIT_WATT, "W" }, + { SR_UNIT_WATT_HOUR, "Wh" }, + { SR_UNIT_METER_SECOND, "m/s" }, + { SR_UNIT_HECTOPASCAL, "hPa" }, + { SR_UNIT_HUMIDITY_293K, "%rF" }, + { SR_UNIT_DEGREE, "\xc2\xb0" }, + { SR_UNIT_HENRY, "H" }, + { SR_UNIT_GRAM, "g" }, + { SR_UNIT_CARAT, "ct" }, + { SR_UNIT_OUNCE, "oz" }, + { SR_UNIT_TROY_OUNCE, "oz t" }, + { SR_UNIT_POUND, "lb" }, + { SR_UNIT_PENNYWEIGHT, "dwt" }, + { SR_UNIT_GRAIN, "gr" }, + { SR_UNIT_TAEL, "tael" }, + { SR_UNIT_MOMME, "momme" }, + { SR_UNIT_TOLA, "tola" }, + { SR_UNIT_PIECE, "pcs" }, + ALL_ZERO +}; + +/* Please use the same order as in enum sr_mqflag (libsigrok.h). */ +static struct unit_mq_string mq_strings[] = { + { SR_MQFLAG_AC, " AC" }, + { SR_MQFLAG_DC, " DC" }, + { SR_MQFLAG_RMS, " RMS" }, + { SR_MQFLAG_DIODE, " DIODE" }, + { SR_MQFLAG_HOLD, " HOLD" }, + { SR_MQFLAG_MAX, " MAX" }, + { SR_MQFLAG_MIN, " MIN" }, + { SR_MQFLAG_AUTORANGE, " AUTO" }, + { SR_MQFLAG_RELATIVE, " REL" }, + { SR_MQFLAG_SPL_FREQ_WEIGHT_A, "(A)" }, + { SR_MQFLAG_SPL_FREQ_WEIGHT_C, "(C)" }, + { SR_MQFLAG_SPL_FREQ_WEIGHT_Z, "(Z)" }, + { SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, "(SPL)" }, + { SR_MQFLAG_SPL_TIME_WEIGHT_S, " S" }, + { SR_MQFLAG_SPL_TIME_WEIGHT_F, " F" }, + { SR_MQFLAG_SPL_LAT, " LAT" }, + /* Not a standard function for SLMs, so this is a made-up notation. */ + { SR_MQFLAG_SPL_PCT_OVER_ALARM, "%oA" }, + { SR_MQFLAG_DURATION, " DURATION" }, + { SR_MQFLAG_AVG, " AVG" }, + { SR_MQFLAG_REFERENCE, " REF" }, + { SR_MQFLAG_UNSTABLE, " UNSTABLE" }, + { SR_MQFLAG_FOUR_WIRE, " 4-WIRE" }, + ALL_ZERO +}; + +SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog, struct sr_analog_encoding *encoding, struct sr_analog_meaning *meaning, struct sr_analog_spec *spec, @@ -57,39 +152,137 @@ SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog, return SR_OK; } -SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog, +/** + * Convert an analog datafeed payload to an array of floats. + * + * @param[in] analog The analog payload to convert. Must not be NULL. + * analog->data, analog->meaning, and analog->encoding + * must not be NULL. + * @param[out] outbuf Memory where to store the result. Must not be NULL. + * + * Sufficient memory for outbuf must have been pre-allocated by the caller, + * who is also responsible for freeing it when no longer needed. + * + * @retval SR_OK Success. + * @retval SR_ERR Unsupported encoding. + * @retval SR_ERR_ARG Invalid argument. + * + * @since 0.4.0 + */ +SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog, float *outbuf) { float offset; - unsigned int b, i; + unsigned int b, i, count; gboolean bigendian; + if (!analog || !(analog->data) || !(analog->meaning) + || !(analog->encoding) || !outbuf) + return SR_ERR_ARG; + + count = analog->num_samples * g_slist_length(analog->meaning->channels); + #ifdef WORDS_BIGENDIAN bigendian = TRUE; #else bigendian = FALSE; #endif if (!analog->encoding->is_float) { - /* TODO */ - sr_err("Only floating-point encoding supported so far."); - return SR_ERR; + float offset = analog->encoding->offset.p / (float)analog->encoding->offset.q; + float scale = analog->encoding->scale.p / (float)analog->encoding->scale.q; + gboolean is_signed = analog->encoding->is_signed; + gboolean is_bigendian = analog->encoding->is_bigendian; + int8_t *data8 = (int8_t *)(analog->data); + int16_t *data16 = (int16_t *)(analog->data); + int32_t *data32 = (int32_t *)(analog->data); + + switch (analog->encoding->unitsize) { + case 1: + if (is_signed) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * data8[i]; + outbuf[i] += offset; + } + } else { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * R8(data8 + i); + outbuf[i] += offset; + } + } + break; + case 2: + if (is_signed && is_bigendian) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RB16S(&data16[i]); + outbuf[i] += offset; + } + } else if (is_bigendian) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RB16(&data16[i]); + outbuf[i] += offset; + } + } else if (is_signed) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RL16S(&data16[i]); + outbuf[i] += offset; + } + } else { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RL16(&data16[i]); + outbuf[i] += offset; + } + } + break; + case 4: + if (is_signed && is_bigendian) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RB32S(&data32[i]); + outbuf[i] += offset; + } + } else if (is_bigendian) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RB32(&data32[i]); + outbuf[i] += offset; + } + } else if (is_signed) { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RL32S(&data32[i]); + outbuf[i] += offset; + } + } else { + for (unsigned int i = 0; i < count; i++) { + outbuf[i] = scale * RL32(&data32[i]); + outbuf[i] += offset; + } + } + break; + default: + sr_err("Unsupported unit size '%d' for analog-to-float conversion.", + analog->encoding->unitsize); + return SR_ERR; + } + return SR_OK; } if (analog->encoding->unitsize == sizeof(float) && analog->encoding->is_bigendian == bigendian - && (analog->encoding->scale.p == analog->encoding->scale.q) + && analog->encoding->scale.p == 1 + && analog->encoding->scale.q == 1 && analog->encoding->offset.p / (float)analog->encoding->offset.q == 0) { /* The data is already in the right format. */ - memcpy(outbuf, analog->data, analog->num_samples * sizeof(float)); + memcpy(outbuf, analog->data, count * sizeof(float)); } else { - for (i = 0; i < analog->num_samples; i += analog->encoding->unitsize) { + for (i = 0; i < count; i += analog->encoding->unitsize) { for (b = 0; b < analog->encoding->unitsize; b++) { if (analog->encoding->is_bigendian == bigendian) - outbuf[i + b] = ((float *)analog->data)[i * analog->encoding->unitsize + b]; + ((uint8_t *)outbuf)[i + b] = + ((uint8_t *)analog->data)[i * analog->encoding->unitsize + b]; else - outbuf[i + (analog->encoding->unitsize - b)] = ((float *)analog->data)[i * analog->encoding->unitsize + b]; + ((uint8_t *)outbuf)[i + (analog->encoding->unitsize - b)] = + ((uint8_t *)analog->data)[i * analog->encoding->unitsize + b]; } - if (analog->encoding->scale.p != analog->encoding->scale.q) + if (analog->encoding->scale.p != 1 + || analog->encoding->scale.q != 1) outbuf[i] = (outbuf[i] * analog->encoding->scale.p) / analog->encoding->scale.q; offset = ((float)analog->encoding->offset.p / (float)analog->encoding->offset.q); outbuf[i] += offset; @@ -98,3 +291,67 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog, return SR_OK; } + +/** + * Convert the unit/MQ/MQ flags in the analog struct to a string. + * + * @param[in] analog Struct containing the unit, MQ and MQ flags. + * Must not be NULL. analog->meaning must not be NULL. + * @param[out] result Pointer to store result. Must not be NULL. + * + * The string is allocated by the function and must be freed by the caller + * after use by calling g_free(). + * + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid argument. + * + * @since 0.4.0 + */ +SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog, + char **result) +{ + int i; + GString *buf; + + if (!analog || !(analog->meaning) || !result) + return SR_ERR_ARG; + + buf = g_string_new(NULL); + + for (i = 0; unit_strings[i].value; i++) { + if (analog->meaning->unit == unit_strings[i].value) { + g_string_assign(buf, unit_strings[i].str); + break; + } + } + + /* More than one MQ flag may apply. */ + for (i = 0; mq_strings[i].value; i++) + if (analog->meaning->mqflags & mq_strings[i].value) + g_string_append(buf, mq_strings[i].str); + + *result = buf->str; + g_string_free(buf, FALSE); + + return SR_OK; +} + +/** + * Set sr_rational r to the given value. + * + * @param[out] r Rational number struct to set. Must not be NULL. + * @param[in] p Numerator. + * @param[in] q Denominator. + * + * @since 0.4.0 + */ +SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q) +{ + if (!r) + return; + + r->p = p; + r->q = q; +} + +/** @} */