pitch_shifter.h

Go to the documentation of this file.

/*
 * Copyright 2020 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef __PITCH_SHIFTER_H_INCLUDED__
#define __PITCH_SHIFTER_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
    
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */
 
typedef enum {
    PITCH_SHIFTER_FFTSIZE_512 = 1,
    PITCH_SHIFTER_FFTSIZE_1024,
    PITCH_SHIFTER_FFTSIZE_2048,
    PITCH_SHIFTER_FFTSIZE_4096,
    PITCH_SHIFTER_FFTSIZE_8192,
    PITCH_SHIFTER_FFTSIZE_16384
 
}PITCH_SHIFTER_FFTSIZE_OPTIONS;
 
#define PITCH_SHIFTER_NUM_FFTSIZE_OPTIONS ( 6 )
 
typedef enum {
    PITCH_SHIFTER_OSAMP_2 = 1,
    PITCH_SHIFTER_OSAMP_4,
    PITCH_SHIFTER_OSAMP_8,
    PITCH_SHIFTER_OSAMP_16,
    PITCH_SHIFTER_OSAMP_32
 
}PITCH_SHIFTER_OSAMP_OPTIONS;
 
#define PITCH_SHIFTER_NUM_OSAMP_OPTIONS ( 5 )
 
#define PITCH_SHIFTER_MAX_SHIFT_FACTOR ( 2.0f )
 
#define PITCH_SHIFTER_MIN_SHIFT_FACTOR ( 0.5f )
 
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void pitch_shifter_create(void** const phPS);
 
void pitch_shifter_destroy(void** const phPS);
 
void pitch_shifter_init(void* const hPS,
                        int samplerate);
 
void pitch_shifter_initCodec(void* const hPS);
 
void pitch_shifter_process(void* const hPS,
                           const float *const * inputs,
                           float* const* const outputs,
                           int nInputs,
                           int nOutputs,
                           int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void pitch_shifter_refreshParams(void* const hPS);
 
void pitch_shifter_setPitchShiftFactor(void* const hPS, float newValue);
 
void pitch_shifter_setNumChannels(void* const hPS, int newValue);
 
void pitch_shifter_setFFTSizeOption(void* const hPS,
                                    PITCH_SHIFTER_FFTSIZE_OPTIONS newOption);
 
void pitch_shifter_setOSampOption(void* const hPS,
                                  PITCH_SHIFTER_OSAMP_OPTIONS newOption);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int pitch_shifter_getFrameSize(void);
 
CODEC_STATUS pitch_shifter_getCodecStatus(void* const hPS);
 
float pitch_shifter_getProgressBar0_1(void* const hPS);
 
void pitch_shifter_getProgressBarText(void* const hPS, char* text);
 
float pitch_shifter_getPitchShiftFactor(void* const hPS);
 
PITCH_SHIFTER_FFTSIZE_OPTIONS pitch_shifter_getFFTSizeOption(void* const hPS);
 
PITCH_SHIFTER_OSAMP_OPTIONS pitch_shifter_getOSampOption(void* const hPS);
 
int pitch_shifter_getNCHrequired(void* const hPS);
 
int pitch_shifter_getProcessingDelay(void* const hPS);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __PITCH_SHIFTER_H_INCLUDED__ */