filter.c

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