/*
  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 __WaveModifier_harmonics_H__
#define __WaveModifier_harmonics_H__
#ifdef __cplusplus
extern "C" {
#endif

typedef struct WaveModifier_harmonics WaveModifier_harmonics;
#define WaveModifier_harmonics_superclass WaveModifier

#include "audiosynth/WaveModifier.h"

// Hard cap; tone count numbers out of range won't apply
#define WAVE_MODIFIER_HARMONICS_TONE_COUNT_MAX 10

#define WaveModifier_harmonics_ivars \
	WaveModifier_ivars \
	\
	float toneCount; \
	float frequencySpacing; \
	float falloff; \
	bool averageAmplitude;

#define WaveModifier_harmonics_vtable(self_type) \
	WaveModifier_vtable(self_type)

stemobject_declare(WaveModifier_harmonics)

WaveModifier_harmonics * WaveModifier_harmonics_create(float toneCount, float frequencySpacing, float falloff, bool averageAmplitude);
bool WaveModifier_harmonics_init(WaveModifier_harmonics * self, float toneCount, float frequencySpacing, float falloff, bool averageAmplitude);
void WaveModifier_harmonics_dispose(WaveModifier_harmonics * self);

WaveModifier_harmonics * WaveModifier_harmonics_copy(WaveModifier_harmonics * self);
bool WaveModifier_harmonics_isEqual(WaveModifier_harmonics * self, compat_type(WaveModifier_harmonics *) compare);
uint32_t WaveModifier_harmonics_hash(WaveModifier_harmonics * self, uint32_t initval);
void WaveModifier_harmonics_initCopy(WaveModifier_harmonics * self, WaveModifier_harmonics * original);
SamplerObject_state * WaveModifier_harmonics_initState(WaveModifier_harmonics * self);
void WaveModifier_harmonics_disposeState(WaveModifier_harmonics * self, SamplerObject_state * state);
void WaveModifier_harmonics_setPropertyValue(WaveModifier_harmonics * self, SamplerObject_state * state, SynthPropertyIdentifier propertyIdentifier, float value);
unsigned int WaveModifier_harmonics_getOwnPropertyCount(WaveModifier_harmonics * self);
SynthProperty * WaveModifier_harmonics_getOwnProperties(WaveModifier_harmonics * self);
float WaveModifier_harmonics_sample(WaveModifier_harmonics * self, SamplerObject_state * state, float phase, float phaseDelta, float time, float timeDelta);

#ifdef __cplusplus
}
#endif
#endif