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
  54         if (!t || !t->sdi || !packet_in || !packet_out)
  55                 return SR_ERR_ARG;
  56         ctx = t->priv;
  57
  58         switch (packet_in->type) {
  59         case SR_DF_ANALOG:
  60                 analog = packet_in->payload;
  61                 analog->encoding->scale.p *= ctx->factor.p;
  62                 analog->encoding->scale.q *= ctx->factor.q;
  63                 break;
  64         default:
  65                 sr_spew("Unsupported packet type %d, ignoring.", packet_in->type);
  66                 break;
  67         }
  68
  69         /* Return the in-place-modified packet. */
  70         *packet_out = packet_in;
  71
  72         return SR_OK;
  73 }
  74
  75 static int cleanup(struct sr_transform *t)
  76 {
  77         struct context *ctx;
  78
  79         if (!t || !t->sdi)
  80                 return SR_ERR_ARG;
  81         ctx = t->priv;
  82
  83         g_free(ctx);
  84         t->priv = NULL;
  85
  86         return SR_OK;
  87 }
  88
  89 static struct sr_option options[] = {
  90         { "factor", "Factor", "Factor by which to scale the analog values", NULL, NULL },
  91         ALL_ZERO
  92 };
  93
  94 static const struct sr_option *get_options(void)
  95 {
  96         int64_t p = 1;
  97         uint64_t q = 1;
  98
  99         /* Default to a scaling factor of 1.0. */
 100         if (!options[0].def)
 101                 options[0].def = g_variant_ref_sink(g_variant_new("(xt)", &p, &q));
 102
 103         return options;
 104 }
 105
 106 SR_PRIV struct sr_transform_module transform_scale = {
 107         .id = "scale",
 108         .name = "Scale",
 109         .desc = "Scale analog values by a specified factor",
 110         .options = get_options,
 111         .init = init,
 112         .receive = receive,
 113         .cleanup = cleanup,
 114 };