]> sigrok.org Git - libsigrok.git/blobdiff - src/analog.c
analog.c: Return SR_ERR_ARG upon invalid arguments.
[libsigrok.git] / src / analog.c
index 9e01566f8799b1e572d2e188e324391696b00569..e6efce2eb58e5132826487dd1002740f144d4da2 100644 (file)
  * 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" },
@@ -56,19 +75,23 @@ static struct unit_mq_string unit_strings[] = {
        { 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" },
@@ -78,12 +101,23 @@ static struct unit_mq_string mq_strings[] = {
        { 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,
@@ -117,13 +151,19 @@ 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,
+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
@@ -137,19 +177,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;
@@ -174,9 +218,12 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
  *
  * @since 0.4.0
  */
-SR_API int sr_analog_float_to_string(float value, int digits, char **result)
+SR_API int sr_analog_float_to_string(float value, unsigned int digits, char **result)
 {
-       int cnt, i;
+       unsigned int cnt, i;
+
+       if (!result)
+               return SR_ERR_ARG;
 
        /* This produces at least one too many digits */
        *result = g_strdup_printf("%.*f", digits, value);
@@ -205,11 +252,16 @@ SR_API int sr_analog_float_to_string(float value, int digits, char **result)
  *
  * @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) {
@@ -229,3 +281,19 @@ 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
+ */
+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;
+}
+
+/** @} */