filter.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-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 <stdint.h>
  22 #include <string.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25
  26 /**
  27  * @defgroup grp_filter Probe filter
  28  *
  29  * Helper functions to filter out unused probes from samples.
  30  *
  31  * @{
  32  */
  33
  34 /**
  35  * Remove unused probes from samples.
  36  *
  37  * Convert sample from maximum probes -- the way the hardware driver sent
  38  * it -- to a sample taking up only as much space as required, with
  39  * unused probes removed.
  40  *
  41  * The "unit size" is the number of bytes used to store probe values.
  42  * For example, a unit size of 1 means one byte is used (which can store
  43  * 8 probe values, each of them is 1 bit). A unit size of 2 means we can
  44  * store 16 probe values, 3 means we can store 24 probe values, and so on.
  45  *
  46  * If the data coming from the logic analyzer has a unit size of 4 for
  47  * example (as the device has 32 probes), but only 2 of them are actually
  48  * used in an acquisition, this function can convert the samples to only
  49  * use up 1 byte per sample (unit size = 1) instead of 4 bytes per sample.
  50  *
  51  * The output will contain the probe values in the order specified via the
  52  * probelist. For example, if in_unitsize = 4, probelist = [5, 16, 30], and
  53  * out_unitsize = 1, then the output samples (each of them one byte in size)
  54  * will have the following format: bit 0 = value of probe 5, bit 1 = value
  55  * of probe 16, bit 2 = value of probe 30. Unused bit(s) in the output byte(s)
  56  * are zero.
  57  *
  58  * The caller must make sure that length_in is not bigger than the memory
  59  * actually allocated for the input data (data_in), as this function does
  60  * not check that.
  61  *
  62  * @param in_unitsize The unit size (>= 1) of the input (data_in).
  63  * @param out_unitsize The unit size (>= 1) the output shall have (data_out).
  64  *                     The requested unit size must be big enough to hold as
  65  *                     much data as is specified by the number of enabled
  66  *                     probes in 'probelist'.
  67  * @param probelist Pointer to a list of probe numbers, numbered starting
  68  *                  from 0. The list is terminated with -1.
  69  * @param data_in Pointer to the input data buffer. Must not be NULL.
  70  * @param length_in The input data length (>= 1), in number of bytes.
  71  * @param data_out Variable which will point to the newly allocated buffer
  72  *                 of output data. The caller is responsible for g_free()'ing
  73  *                 the buffer when it's no longer needed. Must not be NULL.
  74  * @param length_out Pointer to the variable which will contain the output
  75  *                   data length (in number of bytes) when the function
  76  *                   returns SR_OK. Must not be NULL.
  77  *
  78  * @return SR_OK upon success, SR_ERR_MALLOC upon memory allocation errors,
  79  *         or SR_ERR_ARG upon invalid arguments.
  80  *         If something other than SR_OK is returned, the values of
  81  *         out_unitsize, data_out, and length_out are undefined.
  82  */
  83 SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
  84                             const int *probelist, const uint8_t *data_in,
  85                             uint64_t length_in, uint8_t **data_out,
  86                             uint64_t *length_out)
  87 {
  88         unsigned int in_offset, out_offset;
  89         int num_enabled_probes, out_bit, i;
  90         uint64_t sample_in, sample_out;
  91
  92         if (!probelist) {
  93                 sr_err("filter: %s: probelist was NULL", __func__);
  94                 return SR_ERR_ARG;
  95         }
  96
  97         if (!data_in) {
  98                 sr_err("filter: %s: data_in was NULL", __func__);
  99                 return SR_ERR_ARG;
 100         }
 101
 102         if (!data_out) {
 103                 sr_err("filter: %s: data_out was NULL", __func__);
 104                 return SR_ERR_ARG;
 105         }
 106
 107         if (!length_out) {
 108                 sr_err("filter: %s: length_out was NULL", __func__);
 109                 return SR_ERR_ARG;
 110         }
 111
 112         num_enabled_probes = 0;
 113         for (i = 0; probelist[i] != -1; i++)
 114                 num_enabled_probes++;
 115
 116         /* Are there more probes than the target unit size supports? */
 117         if (num_enabled_probes > out_unitsize * 8) {
 118                 sr_err("filter: %s: too many probes (%d) for the target unit "
 119                        "size (%d)", __func__, num_enabled_probes, out_unitsize);
 120                 return SR_ERR_ARG;
 121         }
 122
 123         if (!(*data_out = g_try_malloc(length_in))) {
 124                 sr_err("filter: %s: data_out malloc failed", __func__);
 125                 return SR_ERR_MALLOC;
 126         }
 127
 128         if (num_enabled_probes == in_unitsize * 8) {
 129                 /* All probes are used -- no need to compress anything. */
 130                 memcpy(*data_out, data_in, length_in);
 131                 *length_out = length_in;
 132                 return SR_OK;
 133         }
 134
 135         /* If we reached this point, not all probes are used, so "compress". */
 136         in_offset = out_offset = 0;
 137         while (in_offset <= length_in - in_unitsize) {
 138                 memcpy(&sample_in, data_in + in_offset, in_unitsize);
 139                 sample_out = out_bit = 0;
 140                 for (i = 0; probelist[i] != -1; i++) {
 141                         if (sample_in & (1 << (probelist[i])))
 142                                 sample_out |= (1 << out_bit);
 143                         out_bit++;
 144                 }
 145                 memcpy((*data_out) + out_offset, &sample_out, out_unitsize);
 146                 in_offset += in_unitsize;
 147                 out_offset += out_unitsize;
 148         }
 149         *length_out = out_offset;
 150
 151         return SR_OK;
 152 }
 153
 154 /** @} */