X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fanalog.c;h=8d87302afbfc9ee090943ca0331437e7ed8306ec;hb=0bcdeb90c4d689a8d51797c266c76946619f482e;hp=2116ad7585af721b53e7511beea9ad57a85bbb78;hpb=f7bcc68604cea023043c3067d8bd952d86d69a89;p=libsigrok.git diff --git a/src/analog.c b/src/analog.c index 2116ad75..8d87302a 100644 --- a/src/analog.c +++ b/src/analog.c @@ -17,6 +17,7 @@ * along with this program. If not, see . */ +#include #include #include #include @@ -47,6 +48,7 @@ struct unit_mq_string { 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" }, @@ -88,6 +90,7 @@ static struct unit_mq_string unit_strings[] = { 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" }, @@ -114,7 +117,7 @@ static struct unit_mq_string mq_strings[] = { 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, @@ -148,13 +151,36 @@ 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 @@ -168,19 +194,23 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog, 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; @@ -190,57 +220,31 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog, return SR_OK; } -/* - * Convert a floating point value to a string, limited to the given - * number of decimal digits. - * - * @param value The value to convert. - * @param digits Number of digits after the decimal point to print. - * @param result Pointer to store result. - * - * The string is allocated by the function and must be freed by the caller - * after use by calling g_free(). - * - * @retval SR_OK - * - * @since 0.4.0 - */ -SR_API int sr_analog_float_to_string(float value, int digits, char **result) -{ - int cnt, i; - - /* This produces at least one too many digits */ - *result = g_strdup_printf("%.*f", digits, value); - for (i = 0, cnt = 0; (*result)[i]; i++) { - if (isdigit((*result)[i++])) - cnt++; - if (cnt == digits) { - (*result)[i] = 0; - break; - } - } - - 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 result Pointer to store result. + * @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 + * @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_analog2 *analog, +SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog, char **result) { int i; - GString *buf = g_string_new(NULL); + 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) { @@ -260,14 +264,20 @@ SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog2 *analog, return SR_OK; } -/* +/** * Set sr_rational r to the given value. * - * @param p Numerator - * @param q Denominator + * @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, uint64_t p, uint64_t q) +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; }