]> sigrok.org Git - libsigrok.git/blob - src/transform/scale.c
transform/scale: Use a rational rather than floating point factor.
[libsigrok.git] / src / transform / scale.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2015 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #include <config.h>
22 #include <string.h>
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
25
26 #define LOG_PREFIX "transform/scale"
27
28 struct context {
29         struct sr_rational factor;
30 };
31
32 static int init(struct sr_transform *t, GHashTable *options)
33 {
34         struct context *ctx;
35
36         if (!t || !t->sdi || !options)
37                 return SR_ERR_ARG;
38
39         t->priv = ctx = g_malloc0(sizeof(struct context));
40
41         g_variant_get(g_hash_table_lookup(options, "factor"), "(xt)",
42                         &ctx->factor.p, &ctx->factor.q);
43
44         return SR_OK;
45 }
46
47 static int receive(const struct sr_transform *t,
48                 struct sr_datafeed_packet *packet_in,
49                 struct sr_datafeed_packet **packet_out)
50 {
51         struct context *ctx;
52         const struct sr_datafeed_analog *analog;
53         struct sr_channel *ch;
54         GSList *l;
55         float *fdata;
56         float factor;
57         int i, num_channels, c;
58
59         if (!t || !t->sdi || !packet_in || !packet_out)
60                 return SR_ERR_ARG;
61         ctx = t->priv;
62
63         switch (packet_in->type) {
64         case SR_DF_ANALOG:
65                 analog = packet_in->payload;
66                 fdata = (float *)analog->data;
67                 num_channels = g_slist_length(analog->channels);
68                 factor = (float) ctx->factor.p / ctx->factor.q;
69                 for (i = 0; i < analog->num_samples; i++) {
70                         /* For now scale all values in all channels. */
71                         for (l = analog->channels, c = 0; l; l = l->next, c++) {
72                                 ch = l->data;
73                                 (void)ch;
74                                 fdata[i * num_channels + c] *= factor;
75                         }
76                 }
77                 break;
78         default:
79                 sr_spew("Unsupported packet type %d, ignoring.", packet_in->type);
80                 break;
81         }
82
83         /* Return the in-place-modified packet. */
84         *packet_out = packet_in;
85
86         return SR_OK;
87 }
88
89 static int cleanup(struct sr_transform *t)
90 {
91         struct context *ctx;
92
93         if (!t || !t->sdi)
94                 return SR_ERR_ARG;
95         ctx = t->priv;
96
97         g_free(ctx);
98         t->priv = NULL;
99
100         return SR_OK;
101 }
102
103 static struct sr_option options[] = {
104         { "factor", "Factor", "Factor by which to scale the analog values", NULL, NULL },
105         ALL_ZERO
106 };
107
108 static const struct sr_option *get_options(void)
109 {
110         int64_t p = 1;
111         uint64_t q = 1;
112
113         /* Default to a scaling factor of 1.0. */
114         if (!options[0].def)
115                 options[0].def = g_variant_ref_sink(g_variant_new(("(xt"), &p, &q));
116
117         return options;
118 }
119
120 SR_PRIV struct sr_transform_module transform_scale = {
121         .id = "scale",
122         .name = "Scale",
123         .desc = "Scale analog values by a specified factor",
124         .options = get_options,
125         .init = init,
126         .receive = receive,
127         .cleanup = cleanup,
128 };