/*
  Copyright (c) 2021 Alex Diener
  
  This software is provided 'as-is', without any express or implied
  warranty. In no event will the authors be held liable for any damages
  arising from the use of this software.
  
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
  
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
  
  Alex Diener alex@ludobloom.com
*/

#ifndef __FrequencyCurve_ramp_H__
#define __FrequencyCurve_ramp_H__
#ifdef __cplusplus
extern "C" {
#endif

typedef struct FrequencyCurve_ramp FrequencyCurve_ramp;
#define FrequencyCurve_ramp_superclass FrequencyCurve

#include "audiosynth/FrequencyCurve.h"

typedef enum FrequencyCurve_ramp_boundType {
	RAMP_RESET,
	RAMP_CLAMP,
	RAMP_EXTRAPOLATE
} FrequencyCurve_ramp_boundType;

#define FrequencyCurve_ramp_ivars \
	FrequencyCurve_ivars \
	\
	float linearRamp; \
	float curvedRamp; \
	float onset; \
	float endpoint; \
	float resetPoint; \
	FrequencyCurve_ramp_boundType boundType;

#define FrequencyCurve_ramp_vtable(self_type) \
	FrequencyCurve_vtable(self_type)

stemobject_declare(FrequencyCurve_ramp)

FrequencyCurve_ramp * FrequencyCurve_ramp_create(float baseValue, float linearRamp, float curvedRamp, float onset, float endpoint, float resetPoint, FrequencyCurve_ramp_boundType boundType);
bool FrequencyCurve_ramp_init(FrequencyCurve_ramp * self, float baseValue, float linearRamp, float curvedRamp, float onset, float endpoint, float resetPoint, FrequencyCurve_ramp_boundType boundType);
void FrequencyCurve_ramp_dispose(FrequencyCurve_ramp * self);

FrequencyCurve_ramp * FrequencyCurve_ramp_copy(FrequencyCurve_ramp * self);
bool FrequencyCurve_ramp_isEqual(FrequencyCurve_ramp * self, compat_type(FrequencyCurve_ramp *) compare);
uint32_t FrequencyCurve_ramp_hash(FrequencyCurve_ramp * self, uint32_t initval);
void FrequencyCurve_ramp_initCopy(FrequencyCurve_ramp * self, FrequencyCurve_ramp * original);
SamplerObject_state * FrequencyCurve_ramp_initState(FrequencyCurve_ramp * self);
void FrequencyCurve_ramp_disposeState(FrequencyCurve_ramp * self, SamplerObject_state * state);
unsigned int FrequencyCurve_ramp_getPropertyCount(FrequencyCurve_ramp * self);
SynthProperty FrequencyCurve_ramp_getPropertyAtIndex(FrequencyCurve_ramp * self, unsigned int index);
float FrequencyCurve_ramp_getPropertyValueStateless(FrequencyCurve_ramp * self, SynthPropertyIdentifier propertyIdentifier);
void FrequencyCurve_ramp_setPropertyValue(FrequencyCurve_ramp * self, SamplerObject_state * state, SynthPropertyIdentifier propertyIdentifier, float value);
float FrequencyCurve_ramp_sample(FrequencyCurve_ramp * self, SamplerObject_state * state, float phase, float phaseDelta, float time, float timeDelta);

#ifdef __cplusplus
}
#endif
#endif