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_old *analog_old;
  53         const struct sr_datafeed_analog *analog;
  54         struct sr_channel *ch;
  55         GSList *l;
  56         float *fdata;
  57         float factor;
  58         int i, num_channels, c;
  59
  60         if (!t || !t->sdi || !packet_in || !packet_out)
  61                 return SR_ERR_ARG;
  62         ctx = t->priv;
  63
  64         switch (packet_in->type) {
  65         case SR_DF_ANALOG_OLD:
  66                 analog_old = packet_in->payload;
  67                 fdata = (float *)analog_old->data;
  68                 num_channels = g_slist_length(analog_old->channels);
  69                 factor = (float) ctx->factor.p / ctx->factor.q;
  70                 for (i = 0; i < analog_old->num_samples; i++) {
  71                         /* For now scale all values in all channels. */
  72                         for (l = analog_old->channels, c = 0; l; l = l->next, c++) {
  73                                 ch = l->data;
  74                                 (void)ch;
  75                                 fdata[i * num_channels + c] *= factor;
  76                         }
  77                 }
  78                 break;
  79         case SR_DF_ANALOG:
  80                 analog = packet_in->payload;
  81                 analog->encoding->scale.p *= ctx->factor.p;
  82                 analog->encoding->scale.q *= ctx->factor.q;
  83                 break;
  84         default:
  85                 sr_spew("Unsupported packet type %d, ignoring.", packet_in->type);
  86                 break;
  87         }
  88
  89         /* Return the in-place-modified packet. */
  90         *packet_out = packet_in;
  91
  92         return SR_OK;
  93 }
  94
  95 static int cleanup(struct sr_transform *t)
  96 {
  97         struct context *ctx;
  98
  99         if (!t || !t->sdi)
 100                 return SR_ERR_ARG;
 101         ctx = t->priv;
 102
 103         g_free(ctx);
 104         t->priv = NULL;
 105
 106         return SR_OK;
 107 }
 108
 109 static struct sr_option options[] = {
 110         { "factor", "Factor", "Factor by which to scale the analog values", NULL, NULL },
 111         ALL_ZERO
 112 };
 113
 114 static const struct sr_option *get_options(void)
 115 {
 116         int64_t p = 1;
 117         uint64_t q = 1;
 118
 119         /* Default to a scaling factor of 1.0. */
 120         if (!options[0].def)
 121                 options[0].def = g_variant_ref_sink(g_variant_new("(xt)", &p, &q));
 122
 123         return options;
 124 }
 125
 126 SR_PRIV struct sr_transform_module transform_scale = {
 127         .id = "scale",
 128         .name = "Scale",
 129         .desc = "Scale analog values by a specified factor",
 130         .options = get_options,
 131         .init = init,
 132         .receive = receive,
 133         .cleanup = cleanup,
 134 };