Build: Set local include directories in Makefile.am

[libsigrok.git] / src / analog.c

diff --git a/src/analog.c b/src/analog.c
index ccf6d31934bf605cc4a300d989b83055f9ceaa7d..a0a48de9754115647f90c0ea844683aa5a5db719 100644 (file)
--- a/src/analog.c
+++ b/src/analog.c
@@ -21,10 +21,83 @@
 #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;
+};
+
+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_SECOND, "s" },
+       { SR_UNIT_SIEMENS, "S" },
+       { SR_UNIT_DECIBEL_MW, "dBu" },
+       { SR_UNIT_DECIBEL_VOLT, "dBv" },
+       { 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" },
+       ALL_ZERO
+};
+
+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_DIODE, " DIODE" },
+       { SR_MQFLAG_HOLD, " HOLD" },
+       { SR_MQFLAG_MAX, " MAX" },
+       { SR_MQFLAG_MIN, " MIN" },
+       { SR_MQFLAG_AUTORANGE, " AUTO" },
+       { SR_MQFLAG_RELATIVE, " REL" },
+       { SR_MQFLAG_AVG, " AVG" },
+       { SR_MQFLAG_REFERENCE, " REF" },
+       ALL_ZERO
+};
 
 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
                struct sr_analog_encoding *encoding,
@@ -108,29 +181,80 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
  *
  * @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.
+ * @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 *outbuf,
-               int bufsize)
+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 */
-       snprintf(outbuf, bufsize, "%.*f", digits, value);
-       for (i = 0, cnt = 0; outbuf[i] && i < bufsize; i++) {
-               if (isdigit(outbuf[i++]))
+       *result = g_strdup_printf("%.*f", digits, value);
+       for (i = 0, cnt = 0; (*result)[i]; i++) {
+               if (isdigit((*result)[i++]))
                        cnt++;
                if (cnt == digits) {
-                       outbuf[i] = 0;
+                       (*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.
+ *
+ * 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_unit_to_string(const struct sr_datafeed_analog2 *analog,
+               char **result)
+{
+       int i;
+       GString *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 p Numerator
+ * @param q Denominator
+ */
+SR_API void sr_rational_set(struct sr_rational *r, uint64_t p, uint64_t q)
+{
+       r->p = p;
+       r->q = q;
+}
+
+/** @} */