src/analog.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <stdio.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include <ctype.h>
  25 #include <libsigrok/libsigrok.h>
  26 #include "libsigrok-internal.h"
  27
  28 /** @cond PRIVATE */
  29 #define LOG_PREFIX "analog"
  30 /** @endcond */
  31
  32 /**
  33  * @file
  34  *
  35  * Handling and converting analog data.
  36  */
  37
  38 /**
  39  * @defgroup grp_analog Analog data handling
  40  *
  41  * Handling and converting analog data.
  42  *
  43  * @{
  44  */
  45
  46 struct unit_mq_string {
  47         uint64_t value;
  48         char *str;
  49 };
  50
  51 /* Please use the same order as in enum sr_unit (libsigrok.h). */
  52 static struct unit_mq_string unit_strings[] = {
  53         { SR_UNIT_VOLT, "V" },
  54         { SR_UNIT_AMPERE, "A" },
  55         { SR_UNIT_OHM, "\xe2\x84\xa6" },
  56         { SR_UNIT_FARAD, "F" },
  57         { SR_UNIT_KELVIN, "K" },
  58         { SR_UNIT_CELSIUS, "\xc2\xb0""C" },
  59         { SR_UNIT_FAHRENHEIT, "\xc2\xb0""F" },
  60         { SR_UNIT_HERTZ, "Hz" },
  61         { SR_UNIT_PERCENTAGE, "%" },
  62         { SR_UNIT_BOOLEAN, "" },
  63         { SR_UNIT_SECOND, "s" },
  64         { SR_UNIT_SIEMENS, "S" },
  65         { SR_UNIT_DECIBEL_MW, "dBu" },
  66         { SR_UNIT_DECIBEL_VOLT, "dBv" },
  67         { SR_UNIT_UNITLESS, "" },
  68         { SR_UNIT_DECIBEL_SPL, "dB" },
  69         { SR_UNIT_CONCENTRATION, "ppm" },
  70         { SR_UNIT_REVOLUTIONS_PER_MINUTE, "RPM" },
  71         { SR_UNIT_VOLT_AMPERE, "VA" },
  72         { SR_UNIT_WATT, "W" },
  73         { SR_UNIT_WATT_HOUR, "Wh" },
  74         { SR_UNIT_METER_SECOND, "m/s" },
  75         { SR_UNIT_HECTOPASCAL, "hPa" },
  76         { SR_UNIT_HUMIDITY_293K, "%rF" },
  77         { SR_UNIT_DEGREE, "\xc2\xb0" },
  78         { SR_UNIT_HENRY, "H" },
  79         { SR_UNIT_GRAM, "g" },
  80         { SR_UNIT_CARAT, "ct" },
  81         { SR_UNIT_OUNCE, "oz" },
  82         { SR_UNIT_TROY_OUNCE, "oz t" },
  83         { SR_UNIT_POUND, "lb" },
  84         { SR_UNIT_PENNYWEIGHT, "dwt" },
  85         { SR_UNIT_GRAIN, "gr" },
  86         { SR_UNIT_TAEL, "tael" },
  87         { SR_UNIT_MOMME, "momme" },
  88         { SR_UNIT_TOLA, "tola" },
  89         { SR_UNIT_PIECE, "pcs" },
  90         ALL_ZERO
  91 };
  92
  93 /* Please use the same order as in enum sr_mqflag (libsigrok.h). */
  94 static struct unit_mq_string mq_strings[] = {
  95         { SR_MQFLAG_AC, " AC" },
  96         { SR_MQFLAG_DC, " DC" },
  97         { SR_MQFLAG_RMS, " RMS" },
  98         { SR_MQFLAG_DIODE, " DIODE" },
  99         { SR_MQFLAG_HOLD, " HOLD" },
 100         { SR_MQFLAG_MAX, " MAX" },
 101         { SR_MQFLAG_MIN, " MIN" },
 102         { SR_MQFLAG_AUTORANGE, " AUTO" },
 103         { SR_MQFLAG_RELATIVE, " REL" },
 104         { SR_MQFLAG_SPL_FREQ_WEIGHT_A, "(A)" },
 105         { SR_MQFLAG_SPL_FREQ_WEIGHT_C, "(C)" },
 106         { SR_MQFLAG_SPL_FREQ_WEIGHT_Z, "(Z)" },
 107         { SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, "(SPL)" },
 108         { SR_MQFLAG_SPL_TIME_WEIGHT_S, " S" },
 109         { SR_MQFLAG_SPL_TIME_WEIGHT_F, " F" },
 110         { SR_MQFLAG_SPL_LAT, " LAT" },
 111         /* Not a standard function for SLMs, so this is a made-up notation. */
 112         { SR_MQFLAG_SPL_PCT_OVER_ALARM, "%oA" },
 113         { SR_MQFLAG_DURATION, " DURATION" },
 114         { SR_MQFLAG_AVG, " AVG" },
 115         { SR_MQFLAG_REFERENCE, " REF" },
 116         { SR_MQFLAG_UNSTABLE, " UNSTABLE" },
 117         ALL_ZERO
 118 };
 119
 120 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
 121                 struct sr_analog_encoding *encoding,
 122                 struct sr_analog_meaning *meaning,
 123                 struct sr_analog_spec *spec,
 124                 int digits)
 125 {
 126         memset(analog, 0, sizeof(*analog));
 127         memset(encoding, 0, sizeof(*encoding));
 128         memset(meaning, 0, sizeof(*meaning));
 129         memset(spec, 0, sizeof(*spec));
 130
 131         analog->encoding = encoding;
 132         analog->meaning = meaning;
 133         analog->spec = spec;
 134
 135         encoding->unitsize = sizeof(float);
 136         encoding->is_float = TRUE;
 137 #ifdef WORDS_BIGENDIAN
 138         encoding->is_bigendian = TRUE;
 139 #else
 140         encoding->is_bigendian = FALSE;
 141 #endif
 142         encoding->digits = digits;
 143         encoding->is_digits_decimal = TRUE;
 144         encoding->scale.p = 1;
 145         encoding->scale.q = 1;
 146         encoding->offset.p = 0;
 147         encoding->offset.q = 1;
 148
 149         spec->spec_digits = digits;
 150
 151         return SR_OK;
 152 }
 153
 154 /**
 155  * Convert an analog datafeed payload to an array of floats.
 156  *
 157  * @param[in] analog The analog payload to convert. Must not be NULL.
 158  *                   analog->data, analog->meaning, and analog->encoding
 159  *                   must not be NULL.
 160  * @param[out] outbuf Memory where to store the result. Must not be NULL.
 161  *
 162  * Sufficient memory for outbuf must have been pre-allocated by the caller,
 163  * who is also responsible for freeing it when no longer needed.
 164  *
 165  * @retval SR_OK Success.
 166  * @retval SR_ERR Unsupported encoding.
 167  * @retval SR_ERR_ARG Invalid argument.
 168  *
 169  * @since 0.4.0
 170  */
 171 SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog,
 172                 float *outbuf)
 173 {
 174         float offset;
 175         unsigned int b, i, count;
 176         gboolean bigendian;
 177
 178         if (!analog || !(analog->data) || !(analog->meaning)
 179                         || !(analog->encoding) || !outbuf)
 180                 return SR_ERR_ARG;
 181
 182         count = analog->num_samples * g_slist_length(analog->meaning->channels);
 183
 184 #ifdef WORDS_BIGENDIAN
 185         bigendian = TRUE;
 186 #else
 187         bigendian = FALSE;
 188 #endif
 189         if (!analog->encoding->is_float) {
 190                 /* TODO */
 191                 sr_err("Only floating-point encoding supported so far.");
 192                 return SR_ERR;
 193         }
 194
 195         if (analog->encoding->unitsize == sizeof(float)
 196                         && analog->encoding->is_bigendian == bigendian
 197                         && analog->encoding->scale.p == 1
 198                         && analog->encoding->scale.q == 1
 199                         && analog->encoding->offset.p / (float)analog->encoding->offset.q == 0) {
 200                 /* The data is already in the right format. */
 201                 memcpy(outbuf, analog->data, count * sizeof(float));
 202         } else {
 203                 for (i = 0; i < count; i += analog->encoding->unitsize) {
 204                         for (b = 0; b < analog->encoding->unitsize; b++) {
 205                                 if (analog->encoding->is_bigendian == bigendian)
 206                                         ((uint8_t *)outbuf)[i + b] =
 207                                                 ((uint8_t *)analog->data)[i * analog->encoding->unitsize + b];
 208                                 else
 209                                         ((uint8_t *)outbuf)[i + (analog->encoding->unitsize - b)] =
 210                                                 ((uint8_t *)analog->data)[i * analog->encoding->unitsize + b];
 211                         }
 212                         if (analog->encoding->scale.p != 1
 213                                         || analog->encoding->scale.q != 1)
 214                                 outbuf[i] = (outbuf[i] * analog->encoding->scale.p) / analog->encoding->scale.q;
 215                         offset = ((float)analog->encoding->offset.p / (float)analog->encoding->offset.q);
 216                         outbuf[i] += offset;
 217                 }
 218         }
 219
 220         return SR_OK;
 221 }
 222
 223 /**
 224  * Convert a floating point value to a string, limited to the given
 225  * number of decimal digits.
 226  *
 227  * @param[in] value The value to convert.
 228  * @param[in] digits Number of digits after the decimal point to print.
 229  *                   Must be >= 0.
 230  * @param[out] result Pointer to store result. Must not be NULL.
 231  *
 232  * The string is allocated by the function and must be freed by the caller
 233  * after use by calling g_free().
 234  *
 235  * @retval SR_OK Success.
 236  * @retval SR_ERR_ARG Invalid argument.
 237  *
 238  * @since 0.4.0
 239  */
 240 SR_API int sr_analog_float_to_string(float value, unsigned int digits, char **result)
 241 {
 242         unsigned int cnt, i;
 243
 244         if (!result)
 245                 return SR_ERR_ARG;
 246
 247         /* This produces at least one too many digits. */
 248         *result = g_strdup_printf("%.*f", digits, value);
 249         for (i = 0, cnt = 0; (*result)[i]; i++) {
 250                 if (isdigit((*result)[i++]))
 251                         cnt++;
 252                 if (cnt == digits) {
 253                         (*result)[i] = 0;
 254                         break;
 255                 }
 256         }
 257
 258         return SR_OK;
 259 }
 260
 261 /**
 262  * Convert the unit/MQ/MQ flags in the analog struct to a string.
 263  *
 264  * @param[in] analog Struct containing the unit, MQ and MQ flags.
 265  *                   Must not be NULL. analog->meaning must not be NULL.
 266  * @param[out] result Pointer to store result. Must not be NULL.
 267  *
 268  * The string is allocated by the function and must be freed by the caller
 269  * after use by calling g_free().
 270  *
 271  * @retval SR_OK Success.
 272  * @retval SR_ERR_ARG Invalid argument.
 273  *
 274  * @since 0.4.0
 275  */
 276 SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
 277                 char **result)
 278 {
 279         int i;
 280         GString *buf;
 281
 282         if (!analog || !(analog->meaning) || !result)
 283                 return SR_ERR_ARG;
 284
 285         buf = g_string_new(NULL);
 286
 287         for (i = 0; unit_strings[i].value; i++) {
 288                 if (analog->meaning->unit == unit_strings[i].value) {
 289                         g_string_assign(buf, unit_strings[i].str);
 290                         break;
 291                 }
 292         }
 293
 294         /* More than one MQ flag may apply. */
 295         for (i = 0; mq_strings[i].value; i++)
 296                 if (analog->meaning->mqflags & mq_strings[i].value)
 297                         g_string_append(buf, mq_strings[i].str);
 298
 299         *result = buf->str;
 300         g_string_free(buf, FALSE);
 301
 302         return SR_OK;
 303 }
 304
 305 /**
 306  * Set sr_rational r to the given value.
 307  *
 308  * @param[out] r Rational number struct to set. Must not be NULL.
 309  * @param[in] p Numerator.
 310  * @param[in] q Denominator.
 311  *
 312  * @since 0.4.0
 313  */
 314 SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q)
 315 {
 316         if (!r)
 317                 return;
 318
 319         r->p = p;
 320         r->q = q;
 321 }
 322
 323 /** @} */