]> sigrok.org Git - libsigrok.git/blob - output/analog.c
analog: sane printing of very small and negative values
[libsigrok.git] / output / analog.c
1 /*
2  * This file is part of the sigrok 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 <glib.h>
23 #include "config.h"
24 #include "libsigrok.h"
25 #include "libsigrok-internal.h"
26 #include <math.h>
27
28 struct context {
29         int num_enabled_probes;
30         GPtrArray *probelist;
31         GString *out;
32 };
33
34
35 static int init(struct sr_output *o)
36 {
37         struct context *ctx;
38         struct sr_probe *probe;
39         GSList *l;
40
41         sr_spew("output/analog: initializing");
42         if (!o || !o->sdi)
43                 return SR_ERR_ARG;
44
45         if (!(ctx = g_try_malloc0(sizeof(struct context))))
46                 return SR_ERR_MALLOC;
47         o->internal = ctx;
48
49         /* Get the number of probes and their names. */
50         ctx->probelist = g_ptr_array_new();
51         for (l = o->sdi->probes; l; l = l->next) {
52                 probe = l->data;
53                 if (!probe || !probe->enabled)
54                         continue;
55                 g_ptr_array_add(ctx->probelist, probe->name);
56                 ctx->num_enabled_probes++;
57         }
58
59         ctx->out = g_string_sized_new(512);
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
95         switch (unit) {
96                 case SR_UNIT_VOLT:
97                         si_printf(value, out, "V");
98                         break;
99                 case SR_UNIT_AMPERE:
100                         si_printf(value, out, "A");
101                         break;
102                 case SR_UNIT_OHM:
103                         si_printf(value, out, "");
104                         g_string_append_unichar(out, 0x2126);
105                         break;
106                 case SR_UNIT_FARAD:
107                         si_printf(value, out, "F");
108                         break;
109                 case SR_UNIT_KELVIN:
110                         si_printf(value, out, "K");
111                         break;
112                 case SR_UNIT_CELSIUS:
113                         si_printf(value, out, "");
114                         g_string_append_unichar(out, 0x00b0);
115                         g_string_append_c(out, 'C');
116                         break;
117                 case SR_UNIT_FAHRENHEIT:
118                         si_printf(value, out, "");
119                         g_string_append_unichar(out, 0x00b0);
120                         g_string_append_c(out, 'F');
121                         break;
122                 case SR_UNIT_HERTZ:
123                         si_printf(value, out, "Hz");
124                         break;
125                 case SR_UNIT_PERCENTAGE:
126                         g_string_append_printf(out, "%f%%", value);
127                         break;
128                 case SR_UNIT_BOOLEAN:
129                         if (value > 0)
130                                 g_string_append_printf(out, "TRUE");
131                         else
132                                 g_string_append_printf(out, "FALSE");
133                         break;
134                 case SR_UNIT_SECOND:
135                         si_printf(value, out, "s");
136                         break;
137                 case SR_UNIT_SIEMENS:
138                         si_printf(value, out, "S");
139                         break;
140         }
141         if ((mqflags & (SR_MQFLAG_AC | SR_MQFLAG_DC)) == (SR_MQFLAG_AC | SR_MQFLAG_DC))
142                 g_string_append_printf(out, " AC+DC");
143         else if (mqflags & SR_MQFLAG_AC)
144                 g_string_append_printf(out, " AC");
145         else if (mqflags & SR_MQFLAG_DC)
146                 g_string_append_printf(out, " DC");
147         g_string_append_c(out, '\n');
148
149 }
150
151 static GString *receive(struct sr_output *o, const struct sr_dev_inst *sdi,
152                 struct sr_datafeed_packet *packet)
153 {
154         struct sr_datafeed_analog *analog;
155         struct context *ctx;
156         float *fdata;
157         int i, j;
158
159         if (!o || !o->sdi)
160                 return NULL;
161         ctx = o->internal;
162
163         g_string_set_size(ctx->out, 0);
164         switch (packet->type) {
165         case SR_DF_HEADER:
166                 break;
167         case SR_DF_FRAME_BEGIN:
168                 g_string_append_printf(ctx->out, "FRAME-BEGIN\n");
169                 break;
170         case SR_DF_FRAME_END:
171                 g_string_append_printf(ctx->out, "FRAME-END\n");
172                 break;
173         case SR_DF_ANALOG:
174                 analog = packet->payload;
175                 fdata = (float *)analog->data;
176                 for (i = 0; i < analog->num_samples; i++) {
177                         for (j = 0; j < ctx->num_enabled_probes; j++) {
178                                 g_string_append_printf(ctx->out, "%s: ",
179                                                 (char *)g_ptr_array_index(ctx->probelist, j));
180                                 fancyprint(analog->unit, analog->mqflags,
181                                                 fdata[i + j], ctx->out);
182                         }
183                 }
184                 break;
185         }
186
187         return ctx->out;
188 }
189
190 static int cleanup(struct sr_output *o)
191 {
192         struct context *ctx;
193
194         if (!o || !o->sdi)
195                 return SR_ERR_ARG;
196         ctx = o->internal;
197
198         g_ptr_array_free(ctx->probelist, 1);
199         g_string_free(ctx->out, 1);
200         g_free(ctx);
201         o->internal = NULL;
202
203         return SR_OK;
204 }
205
206
207 SR_PRIV struct sr_output_format output_analog = {
208         .id = "analog",
209         .description = "Analog data",
210         .df_type = SR_DF_ANALOG,
211         .init = init,
212         .recv = receive,
213         .cleanup = cleanup
214 };