deps/libretro-common/include/audio/dsp_filter.h

   1 /* Copyright  (C) 2010-2020 The RetroArch team
   2  *
   3  * ---------------------------------------------------------------------------------------
   4  * The following license statement only applies to this file (dsp_filter.h).
   5  * ---------------------------------------------------------------------------------------
   6  *
   7  * Permission is hereby granted, free of charge,
   8  * to any person obtaining a copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
  11  * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  16  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #ifndef __LIBRETRO_SDK_AUDIO_DSP_FILTER_H
  24 #define __LIBRETRO_SDK_AUDIO_DSP_FILTER_H
  25
  26 #include <retro_common_api.h>
  27
  28 RETRO_BEGIN_DECLS
  29
  30 typedef struct retro_dsp_filter retro_dsp_filter_t;
  31
  32 retro_dsp_filter_t *retro_dsp_filter_new(const char *filter_config,
  33       void *string_data, float sample_rate);
  34
  35 void retro_dsp_filter_free(retro_dsp_filter_t *dsp);
  36
  37 /**
  38  * A struct that groups the input and output of a DSP filter.
  39  */
  40 struct retro_dsp_data
  41 {
  42    float *input;
  43    unsigned input_frames;
  44
  45    /* Set by retro_dsp_filter_process(). */
  46    float *output;
  47    unsigned output_frames;
  48 };
  49
  50 void retro_dsp_filter_process(retro_dsp_filter_t *dsp,
  51       struct retro_dsp_data *data);
  52
  53 RETRO_END_DECLS
  54
  55 #endif