include/filters/GP_FilterParam.h

   1 /*****************************************************************************
   2  * This file is part of gfxprim library.                                     *
   3  *                                                                           *
   4  * Gfxprim is free software; you can redistribute it and/or                  *
   5  * modify it under the terms of the GNU Lesser General Public                *
   6  * License as published by the Free Software Foundation; either              *
   7  * version 2.1 of the License, or (at your option) any later version.        *
   8  *                                                                           *
   9  * Gfxprim is distributed in the hope that it will be useful,                *
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  12  * Lesser General Public License for more details.                           *
  13  *                                                                           *
  14  * You should have received a copy of the GNU Lesser General Public          *
  15  * License along with gfxprim; if not, write to the Free Software            *
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor,                        *
  17  * Boston, MA  02110-1301  USA                                               *
  18  *                                                                           *
  19  * Copyright (C) 2009-2012 Cyril Hrubis <metan@ucw.cz>                       *
  20  *                                                                           *
  21  *****************************************************************************/
  22
  23 /*
  24
  25   Filter per channel parameter passing code.
  26
  27  */
  28
  29 #ifndef FILTERS_GP_FILTER_PARAM_H
  30 #define FILTERS_GP_FILTER_PARAM_H
  31
  32 #include "core/GP_Pixel.h"
  33
  34 #include <stdint.h>
  35
  36 typedef union GP_FilterParamVal {
  37         float f;
  38         uint32_t ui;
  39         int32_t i;
  40         void *ptr;
  41 } GP_FilterParamVal;
  42
  43 /*
  44  * Filter parameter structure for one channel.
  45  *
  46  * Filter takes, empty channel name terminated, arrray of these as parameter.
  47  */
  48 typedef struct GP_FilterParam {
  49         //TODO: this must be > than maximal channel name (now it's 2)
  50         char channel_name[2];
  51         union GP_FilterParamVal val;
  52 } GP_FilterParam;
  53
  54 /*
  55  * Creates filter param structure large enough for given pixel_type.
  56  *
  57  * The returned structure has initalized channel_names and terminator.
  58  */
  59 GP_FilterParam *GP_FilterParamCreate(GP_PixelType pixel_type);
  60
  61 /*
  62  * Destroys filter param structure.
  63  */
  64 void GP_FilterParamDestroy(GP_FilterParam *self);
  65
  66 /*
  67  * Takes array of filter parameters and returns filter parameter by a channel
  68  * name.
  69  *
  70  * Returns NULL if channel wasn't found.
  71  */
  72 GP_FilterParam *GP_FilterParamChannel(GP_FilterParam params[],
  73                                       const char *channel_name);
  74
  75 /*
  76  * Returns number of filter channels.
  77  */
  78 uint32_t GP_FilterParamChannels(GP_FilterParam params[]);
  79
  80 /*
  81  * Compares param channels and pixel type channels. Returns zero if channels
  82  * match.
  83  */
  84 int GP_FilterParamCheckPixelType(GP_FilterParam params[],
  85                                  GP_PixelType pixel_type);
  86
  87 /*
  88  * Returns zero only if params have exactly same channels as array of
  89  * channel_names.
  90  */
  91 int GP_FilterParamCheckChannels(GP_FilterParam params[],
  92                                 const char *channel_names[]);
  93
  94 /*
  95  * Create and initalize the structure on the stack
  96  */
  97 #define GP_FILTER_PARAMS(pixel_type, name) \
  98         GP_FilterParam name[GP_PixelTypes[pixel_type].numchannels + 1]; \
  99         GP_FilterParamInitChannels(name, pixel_type);
 100
 101 /*
 102  * Initalize param names and terminator.
 103  *
 104  * Sets all values to 0.
 105  */
 106 void GP_FilterParamInitChannels(GP_FilterParam params[],
 107                                 GP_PixelType pixel_type);
 108
 109 /*
 110  * Sets all values to integer value.
 111  */
 112 void GP_FilterParamSetIntAll(GP_FilterParam params[], int32_t val);
 113
 114 /*
 115  * Sets integer value. Returns 0 if such value was found, non-zero otherwise.
 116  */
 117 int GP_FilterParamSetInt(GP_FilterParam params[], const char *channel_name,
 118                          int32_t val);
 119
 120 /*
 121  * Sets all values to float value.
 122  */
 123 void GP_FilterParamSetFloatAll(GP_FilterParam params[], float val);
 124
 125 /*
 126  * Sets float value. Returns 0 if such value was found, non-zero otherwise.
 127  */
 128 int GP_FilterParamSetFloat(GP_FilterParam params[], const char *channel_name,
 129                            float val);
 130
 131 /*
 132  * Sets all values to unsigned integer value.
 133  */
 134 void GP_FilterParamSetUIntAll(GP_FilterParam params[], uint32_t val);
 135
 136 /*
 137  * Sets unsigned integer value. Returns 0 if such value was found, non-zero
 138  * otherwise.
 139  */
 140 int GP_FilterParamSetUInt(GP_FilterParam params[], const char *channel_name,
 141                           uint32_t val);
 142
 143 /*
 144  * Sets all values to pointer value.
 145  */
 146 void GP_FilterParamSetPtrAll(GP_FilterParam params[], void *ptr);
 147
 148 /*
 149  * Sets pointer value. Returns 0 if such value was found, non-zero otherwise.
 150  */
 151 int GP_FilterParamSetPtr(GP_FilterParam params[], const char *channel_name,
 152                          void *ptr);
 153
 154 /*
 155  * Call free on all pointer values.
 156  */
 157 void GP_FilterParamFreePtrAll(GP_FilterParam params[]);
 158
 159 /*
 160  * Functions to print the array.
 161  */
 162 void GP_FilterParamPrintInt(GP_FilterParam params[]);
 163 void GP_FilterParamPrintUInt(GP_FilterParam params[]);
 164 void GP_FilterParamPrintFloat(GP_FilterParam params[]);
 165 void GP_FilterParamPrintPtr(GP_FilterParam params[]);
 166
 167 #endif /* FILTERS_GP_FILTER_PARAM_H */