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 <stdio.h>
  21 #include <stdint.h>
  22 #include <string.h>
  23 #include <ctype.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "analog"
  28
  29 struct unit_mq_string {
  30         uint64_t value;
  31         char *str;
  32 };
  33
  34 static struct unit_mq_string unit_strings[] = {
  35         { SR_UNIT_VOLT, "V" },
  36         { SR_UNIT_AMPERE, "A" },
  37         { SR_UNIT_OHM, "\xe2\x84\xa6" },
  38         { SR_UNIT_FARAD, "F" },
  39         { SR_UNIT_HENRY, "H" },
  40         { SR_UNIT_KELVIN, "K" },
  41         { SR_UNIT_CELSIUS, "\xc2\xb0""C" },
  42         { SR_UNIT_FAHRENHEIT, "\xc2\xb0""F" },
  43         { SR_UNIT_HERTZ, "Hz" },
  44         { SR_UNIT_PERCENTAGE, "%" },
  45         { SR_UNIT_SECOND, "s" },
  46         { SR_UNIT_SIEMENS, "S" },
  47         { SR_UNIT_DECIBEL_MW, "dBu" },
  48         { SR_UNIT_DECIBEL_VOLT, "dBv" },
  49         { SR_UNIT_DECIBEL_SPL, "dB" },
  50         { SR_UNIT_CONCENTRATION, "ppm" },
  51         { SR_UNIT_REVOLUTIONS_PER_MINUTE, "RPM" },
  52         { SR_UNIT_VOLT_AMPERE, "VA" },
  53         { SR_UNIT_WATT, "W" },
  54         { SR_UNIT_WATT_HOUR, "Wh" },
  55         { SR_UNIT_METER_SECOND, "m/s" },
  56         { SR_UNIT_HECTOPASCAL, "hPa" },
  57         { SR_UNIT_HUMIDITY_293K, "%rF" },
  58         { SR_UNIT_DEGREE, "\xc2\xb0" },
  59         ALL_ZERO
  60 };
  61
  62 static struct unit_mq_string mq_strings[] = {
  63         { SR_MQFLAG_SPL_FREQ_WEIGHT_A, "(A)" },
  64         { SR_MQFLAG_SPL_FREQ_WEIGHT_C, "(C)" },
  65         { SR_MQFLAG_SPL_FREQ_WEIGHT_Z, "(Z)" },
  66         { SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, "(SPL)" },
  67         { SR_MQFLAG_SPL_TIME_WEIGHT_S, " S" },
  68         { SR_MQFLAG_SPL_TIME_WEIGHT_F, " F" },
  69         { SR_MQFLAG_SPL_LAT, " LAT" },
  70         /* Not a standard function for SLMs, so this is a made-up notation. */
  71         { SR_MQFLAG_SPL_PCT_OVER_ALARM, "%oA" },
  72         { SR_MQFLAG_AC, " AC" },
  73         { SR_MQFLAG_DC, " DC" },
  74         { SR_MQFLAG_RMS, " RMS" },
  75         { SR_MQFLAG_DIODE, " DIODE" },
  76         { SR_MQFLAG_HOLD, " HOLD" },
  77         { SR_MQFLAG_MAX, " MAX" },
  78         { SR_MQFLAG_MIN, " MIN" },
  79         { SR_MQFLAG_AUTORANGE, " AUTO" },
  80         { SR_MQFLAG_RELATIVE, " REL" },
  81         { SR_MQFLAG_AVG, " AVG" },
  82         { SR_MQFLAG_REFERENCE, " REF" },
  83         ALL_ZERO
  84 };
  85
  86 SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog,
  87                 struct sr_analog_encoding *encoding,
  88                 struct sr_analog_meaning *meaning,
  89                 struct sr_analog_spec *spec,
  90                 int digits)
  91 {
  92         memset(analog, 0, sizeof(*analog));
  93         memset(encoding, 0, sizeof(*encoding));
  94         memset(meaning, 0, sizeof(*meaning));
  95         memset(spec, 0, sizeof(*spec));
  96
  97         analog->encoding = encoding;
  98         analog->meaning = meaning;
  99         analog->spec = spec;
 100
 101         encoding->unitsize = sizeof(float);
 102         encoding->is_float = TRUE;
 103 #ifdef WORDS_BIGENDIAN
 104         encoding->is_bigendian = TRUE;
 105 #else
 106         encoding->is_bigendian = FALSE;
 107 #endif
 108         encoding->digits = digits;
 109         encoding->is_digits_decimal = TRUE;
 110         encoding->scale.p = 1;
 111         encoding->scale.q = 1;
 112         encoding->offset.p = 0;
 113         encoding->offset.q = 1;
 114
 115         spec->spec_digits = digits;
 116
 117         return SR_OK;
 118 }
 119
 120 SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
 121                 float *outbuf)
 122 {
 123         float offset;
 124         unsigned int b, i;
 125         gboolean bigendian;
 126
 127 #ifdef WORDS_BIGENDIAN
 128         bigendian = TRUE;
 129 #else
 130         bigendian = FALSE;
 131 #endif
 132         if (!analog->encoding->is_float) {
 133                 /* TODO */
 134                 sr_err("Only floating-point encoding supported so far.");
 135                 return SR_ERR;
 136         }
 137
 138         if (analog->encoding->unitsize == sizeof(float)
 139                         && analog->encoding->is_bigendian == bigendian
 140                         && (analog->encoding->scale.p == analog->encoding->scale.q)
 141                         && analog->encoding->offset.p / (float)analog->encoding->offset.q == 0) {
 142                 /* The data is already in the right format. */
 143                 memcpy(outbuf, analog->data, analog->num_samples * sizeof(float));
 144         } else {
 145                 for (i = 0; i < analog->num_samples; i += analog->encoding->unitsize) {
 146                         for (b = 0; b < analog->encoding->unitsize; b++) {
 147                                 if (analog->encoding->is_bigendian == bigendian)
 148                                         outbuf[i + b] = ((float *)analog->data)[i * analog->encoding->unitsize + b];
 149                                 else
 150                                         outbuf[i + (analog->encoding->unitsize - b)] = ((float *)analog->data)[i * analog->encoding->unitsize + b];
 151                         }
 152                         if (analog->encoding->scale.p != analog->encoding->scale.q)
 153                                 outbuf[i] = (outbuf[i] * analog->encoding->scale.p) / analog->encoding->scale.q;
 154                         offset = ((float)analog->encoding->offset.p / (float)analog->encoding->offset.q);
 155                         outbuf[i] += offset;
 156                 }
 157         }
 158
 159         return SR_OK;
 160 }
 161
 162 /*
 163  * Convert a floating point value to a string, limited to the given
 164  * number of decimal digits.
 165  *
 166  * @param value The value to convert.
 167  * @param digits Number of digits after the decimal point to print.
 168  * @param result Pointer to store result.
 169  *
 170  * The string is allocated by the function and must be freed by the caller
 171  * after use by calling g_free().
 172  *
 173  * @retval SR_OK
 174  *
 175  * @since 0.4.0
 176  */
 177 SR_API int sr_analog_float_to_string(float value, int digits, char **result)
 178 {
 179         int cnt, i;
 180
 181         /* This produces at least one too many digits */
 182         *result = g_strdup_printf("%.*f", digits, value);
 183         for (i = 0, cnt = 0; (*result)[i]; i++) {
 184                 if (isdigit((*result)[i++]))
 185                         cnt++;
 186                 if (cnt == digits) {
 187                         (*result)[i] = 0;
 188                         break;
 189                 }
 190         }
 191
 192         return SR_OK;
 193 }
 194
 195 /*
 196  * Convert the unit/MQ/MQ flags in the analog struct to a string.
 197  *
 198  * @param analog Struct containing the unit, MQ and MQ flags.
 199  * @param result Pointer to store result.
 200  *
 201  * The string is allocated by the function and must be freed by the caller
 202  * after use by calling g_free().
 203  *
 204  * @retval SR_OK
 205  *
 206  * @since 0.4.0
 207  */
 208 SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog2 *analog,
 209                 char **result)
 210 {
 211         int i;
 212         GString *buf = g_string_new(NULL);
 213
 214         for (i = 0; unit_strings[i].value; i++) {
 215                 if (analog->meaning->unit == unit_strings[i].value) {
 216                         g_string_assign(buf, unit_strings[i].str);
 217                         break;
 218                 }
 219         }
 220
 221         /* More than one MQ flag may apply. */
 222         for (i = 0; mq_strings[i].value; i++)
 223                 if (analog->meaning->mqflags & mq_strings[i].value)
 224                         g_string_append(buf, mq_strings[i].str);
 225
 226         *result = buf->str;
 227         g_string_free(buf, FALSE);
 228
 229         return SR_OK;
 230 }
 231
 232 /*
 233  * Set sr_rational r to the given value.
 234  *
 235  * @param p Numerator
 236  * @param q Denominator
 237  */
 238 SR_API void sr_rational_set(struct sr_rational *r, uint64_t p, uint64_t q)
 239 {
 240         r->p = p;
 241         r->q = q;
 242 }
 243