src/output/analog.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 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 <stdlib.h>
  21 #include <string.h>
  22 #include <math.h>
  23 #include <glib.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "output/analog"
  28
  29 struct context {
  30         int num_enabled_channels;
  31         GPtrArray *channellist;
  32 };
  33
  34 static int init(struct sr_output *o, GHashTable *options)
  35 {
  36         struct context *ctx;
  37         struct sr_channel *ch;
  38         GSList *l;
  39
  40         (void)options;
  41
  42         if (!o || !o->sdi)
  43                 return SR_ERR_ARG;
  44
  45         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
  46                 sr_err("Output module context malloc failed.");
  47                 return SR_ERR_MALLOC;
  48         }
  49         o->priv = ctx;
  50
  51         /* Get the number of channels and their names. */
  52         ctx->channellist = g_ptr_array_new();
  53         for (l = o->sdi->channels; l; l = l->next) {
  54                 ch = l->data;
  55                 if (!ch || !ch->enabled)
  56                         continue;
  57                 g_ptr_array_add(ctx->channellist, ch->name);
  58                 ctx->num_enabled_channels++;
  59         }
  60
  61         return SR_OK;
  62 }
  63
  64 static void si_printf(float value, GString *out, char *unitstr)
  65 {
  66         float v;
  67
  68         if (signbit(value))
  69                 v = -(value);
  70         else
  71                 v = value;
  72
  73         if (v < 1e-12 || v > 1e+12)
  74                 g_string_append_printf(out, "%f %s", value, unitstr);
  75         else if (v > 1e+9)
  76                 g_string_append_printf(out, "%f G%s", value / 1e+9, unitstr);
  77         else if (v > 1e+6)
  78                 g_string_append_printf(out, "%f M%s", value / 1e+6, unitstr);
  79         else if (v > 1e+3)
  80                 g_string_append_printf(out, "%f k%s", value / 1e+3, unitstr);
  81         else if (v < 1e-9)
  82                 g_string_append_printf(out, "%f n%s", value * 1e+9, unitstr);
  83         else if (v < 1e-6)
  84                 g_string_append_printf(out, "%f u%s", value * 1e+6, unitstr);
  85         else if (v < 1e-3)
  86                 g_string_append_printf(out, "%f m%s", value * 1e+3, unitstr);
  87         else
  88                 g_string_append_printf(out, "%f %s", value, unitstr);
  89
  90 }
  91
  92 static void fancyprint(int unit, int mqflags, float value, GString *out)
  93 {
  94         switch (unit) {
  95         case SR_UNIT_VOLT:
  96                 si_printf(value, out, "V");
  97                 break;
  98         case SR_UNIT_AMPERE:
  99                 si_printf(value, out, "A");
 100                 break;
 101         case SR_UNIT_OHM:
 102                 si_printf(value, out, "");
 103                 g_string_append_unichar(out, 0x2126);
 104                 break;
 105         case SR_UNIT_FARAD:
 106                 si_printf(value, out, "F");
 107                 break;
 108         case SR_UNIT_HENRY:
 109                 si_printf(value, out, "H");
 110                 break;
 111         case SR_UNIT_KELVIN:
 112                 si_printf(value, out, "K");
 113                 break;
 114         case SR_UNIT_CELSIUS:
 115                 si_printf(value, out, "");
 116                 g_string_append_unichar(out, 0x00b0);
 117                 g_string_append_c(out, 'C');
 118                 break;
 119         case SR_UNIT_FAHRENHEIT:
 120                 si_printf(value, out, "");
 121                 g_string_append_unichar(out, 0x00b0);
 122                 g_string_append_c(out, 'F');
 123                 break;
 124         case SR_UNIT_HERTZ:
 125                 si_printf(value, out, "Hz");
 126                 break;
 127         case SR_UNIT_PERCENTAGE:
 128                 g_string_append_printf(out, "%f %%", value);
 129                 break;
 130         case SR_UNIT_BOOLEAN:
 131                 if (value > 0)
 132                         g_string_append_printf(out, "TRUE");
 133                 else
 134                         g_string_append_printf(out, "FALSE");
 135                 break;
 136         case SR_UNIT_SECOND:
 137                 si_printf(value, out, "s");
 138                 break;
 139         case SR_UNIT_SIEMENS:
 140                 si_printf(value, out, "S");
 141                 break;
 142         case SR_UNIT_DECIBEL_MW:
 143                 si_printf(value, out, "dBu");
 144                 break;
 145         case SR_UNIT_DECIBEL_VOLT:
 146                 si_printf(value, out, "dBV");
 147                 break;
 148         case SR_UNIT_DECIBEL_SPL:
 149                 if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
 150                         si_printf(value, out, "dB(A)");
 151                 else if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_C)
 152                         si_printf(value, out, "dB(C)");
 153                 else if (mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_Z)
 154                         si_printf(value, out, "dB(Z)");
 155                 else
 156                         /* No frequency weighting, or non-standard "flat" */
 157                         si_printf(value, out, "dB(SPL)");
 158                 if (mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_S)
 159                         g_string_append(out, " S");
 160                 else if (mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
 161                         g_string_append(out, " F");
 162                 if (mqflags & SR_MQFLAG_SPL_LAT)
 163                         g_string_append(out, " LAT");
 164                 else if (mqflags & SR_MQFLAG_SPL_PCT_OVER_ALARM)
 165                         /* Not a standard function for SLMs, so this is
 166                          * a made-up notation. */
 167                         g_string_append(out, " %oA");
 168                 break;
 169         case SR_UNIT_CONCENTRATION:
 170                 g_string_append_printf(out, "%f ppm", value * 1000000);
 171                 break;
 172         case SR_UNIT_REVOLUTIONS_PER_MINUTE:
 173                 si_printf(value, out, "RPM");
 174                 break;
 175         case SR_UNIT_VOLT_AMPERE:
 176                 si_printf(value, out, "VA");
 177                 break;
 178         case SR_UNIT_WATT:
 179                 si_printf(value, out, "W");
 180                 break;
 181         case SR_UNIT_WATT_HOUR:
 182                 si_printf(value, out, "Wh");
 183                 break;
 184         case SR_UNIT_METER_SECOND:
 185                 si_printf(value, out, "m/s");
 186                 break;
 187         case SR_UNIT_HECTOPASCAL:
 188                 si_printf(value, out, "hPa");
 189                 break;
 190         case SR_UNIT_HUMIDITY_293K:
 191                 si_printf(value, out, "%rF");
 192                 break;
 193         case SR_UNIT_DEGREE:
 194                 si_printf(value, out, "");
 195                 g_string_append_unichar(out, 0x00b0);
 196                 break;
 197         default:
 198                 si_printf(value, out, "");
 199                 break;
 200         }
 201
 202         if (mqflags & SR_MQFLAG_AC)
 203                 g_string_append_printf(out, " AC");
 204         if (mqflags & SR_MQFLAG_DC)
 205                 g_string_append_printf(out, " DC");
 206         if (mqflags & SR_MQFLAG_RMS)
 207                 g_string_append_printf(out, " RMS");
 208         if (mqflags & SR_MQFLAG_DIODE)
 209                 g_string_append_printf(out, " DIODE");
 210         if (mqflags & SR_MQFLAG_HOLD)
 211                 g_string_append_printf(out, " HOLD");
 212         if (mqflags & SR_MQFLAG_MAX)
 213                 g_string_append_printf(out, " MAX");
 214         if (mqflags & SR_MQFLAG_MIN)
 215                 g_string_append_printf(out, " MIN");
 216         if (mqflags & SR_MQFLAG_AUTORANGE)
 217                 g_string_append_printf(out, " AUTO");
 218         if (mqflags & SR_MQFLAG_RELATIVE)
 219                 g_string_append_printf(out, " REL");
 220         if (mqflags & SR_MQFLAG_AVG)
 221                 g_string_append_printf(out, " AVG");
 222         if (mqflags & SR_MQFLAG_REFERENCE)
 223                 g_string_append_printf(out, " REF");
 224         if (mqflags & SR_MQFLAG_AUTOMQ)
 225                 g_string_append_printf(out, " AUTOMQ");
 226         if (mqflags & SR_MQFLAG_AUTOMODEL)
 227                 g_string_append_printf(out, " AUTOMODEL");
 228         g_string_append_c(out, '\n');
 229 }
 230
 231 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
 232                 GString **out)
 233 {
 234         const struct sr_datafeed_analog *analog;
 235         struct sr_channel *ch;
 236         GSList *l;
 237         const float *fdata;
 238         int num_channels, i, c;
 239
 240         *out = NULL;
 241         if (!o || !o->sdi)
 242                 return SR_ERR_ARG;
 243
 244         switch (packet->type) {
 245         case SR_DF_FRAME_BEGIN:
 246                 *out = g_string_new("FRAME-BEGIN\n");
 247                 break;
 248         case SR_DF_FRAME_END:
 249                 *out = g_string_new("FRAME-END\n");
 250                 break;
 251         case SR_DF_ANALOG:
 252                 analog = packet->payload;
 253                 fdata = (const float *)analog->data;
 254                 *out = g_string_sized_new(512);
 255                 num_channels = g_slist_length(analog->channels);
 256                 for (i = 0; i < analog->num_samples; i++) {
 257                         for (l = analog->channels, c = 0; l; l = l->next, c++) {
 258                                 ch = l->data;
 259                                 g_string_append_printf(*out, "%s: ", ch->name);
 260                                 fancyprint(analog->unit, analog->mqflags,
 261                                                 fdata[i * num_channels + c], *out);
 262                         }
 263                 }
 264                 break;
 265         }
 266
 267         return SR_OK;
 268 }
 269
 270 static int cleanup(struct sr_output *o)
 271 {
 272         struct context *ctx;
 273
 274         if (!o || !o->sdi)
 275                 return SR_ERR_ARG;
 276         ctx = o->priv;
 277
 278         g_ptr_array_free(ctx->channellist, 1);
 279         g_free(ctx);
 280         o->priv = NULL;
 281
 282         return SR_OK;
 283 }
 284
 285 SR_PRIV struct sr_output_module output_analog = {
 286         .id = "analog",
 287         .name = "Analog",
 288         .desc = "Analog data and types",
 289         .options = NULL,
 290         .init = init,
 291         .receive = receive,
 292         .cleanup = cleanup
 293 };