* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include <config.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <ctype.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
+/** @cond PRIVATE */
#define LOG_PREFIX "analog"
+/** @endcond */
+
+/**
+ * @file
+ *
+ * Handling and converting analog data.
+ */
+
+/**
+ * @defgroup grp_analog Analog data handling
+ *
+ * Handling and converting analog data.
+ *
+ * @{
+ */
struct unit_mq_string {
uint64_t value;
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_HENRY, "H" },
{ 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_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_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_AC, " AC" },
{ SR_MQFLAG_DC, " DC" },
{ SR_MQFLAG_RMS, " RMS" },
{ 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" },
ALL_ZERO
};
-SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
+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,
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
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;
return SR_OK;
}
-/*
- * Convert a floating point value to a string, limited to the given
- * number of decimal digits.
+/**
+ * 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.
*
- * @param value The value to convert.
- * @param digits Number of digits after the decimal point to print.
- * @param outbuf Buffer in which the resulting string will be placed.
- * @param bufsize Size of the buffer in bytes.
+ * The string is allocated by the function and must be freed by the caller
+ * after use by calling g_free().
*
- * @retval SR_OK
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
*
* @since 0.4.0
*/
-SR_API int sr_analog_float_to_string(float value, int digits, char *outbuf,
- int bufsize)
+SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
+ char **result)
{
- int cnt, i;
-
- /* This produces at least one too many digits */
- snprintf(outbuf, bufsize, "%.*f", digits, value);
- for (i = 0, cnt = 0; outbuf[i] && i < bufsize; i++) {
- if (isdigit(outbuf[i++]))
- cnt++;
- if (cnt == digits) {
- outbuf[i] = 0;
+ 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;
}
-/*
- * Convert the unit/MQ/MQ flags in the analog struct to a string.
- *
- * @param analog Struct containing the unit, MQ and MQ flags.
- * @param outbuf Buffer in which the resulting string will be placed.
- * @param bufsize Size of the buffer in bytes.
+/**
+ * Set sr_rational r to the given value.
*
- * @retval SR_OK
+ * @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 int sr_analog_unit_to_string(const struct sr_datafeed_analog2 *analog,
- char *outbuf, int bufsize)
+SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q)
{
- int len, i;
+ if (!r)
+ return;
- outbuf[0] = 0;
- for (i = 0; unit_strings[i].value; i++) {
- if (analog->meaning->unit == unit_strings[i].value) {
- strncpy(outbuf, unit_strings[i].str, bufsize);
- break;
- }
- }
-
- /* More than one MQ flag may apply. */
- for (i = 0; mq_strings[i].value; i++) {
- if (analog->meaning->mqflags & mq_strings[i].value) {
- len = strlen(outbuf);
- strncat(outbuf + len, mq_strings[i].str, bufsize - len);
- }
- }
-
- return SR_OK;
+ r->p = p;
+ r->q = q;
}
+/** @} */