filter.c

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