/*
  Copyright (c) 2023 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_ringModulation_H__
#define __WaveModifier_ringModulation_H__

typedef struct WaveModifier_ringModulation WaveModifier_ringModulation;
#define WaveModifier_ringModulation_superclass WaveModifier

#include "audiosynth/WaveModifier.h"
#include "audiosynth/WaveSampler.h"

#define WaveModifier_ringModulation_ivars \
	WaveModifier_ivars \
	\
	WaveSampler * carrier; \
	float carrierFrequency; \
	float carrierPhaseOffset;

#define WaveModifier_ringModulation_vtable(self_type) \
	WaveModifier_vtable(self_type)

stemobject_declare(WaveModifier_ringModulation)

// Takes ownership of carrier
WaveModifier_ringModulation * WaveModifier_ringModulation_create(compat_type(WaveSampler *) carrier, float carrierFrequency, float carrierPhaseOffset);
bool WaveModifier_ringModulation_init(WaveModifier_ringModulation * self, compat_type(WaveSampler *) carrier, float carrierFrequency, float carrierPhaseOffset);
void WaveModifier_ringModulation_dispose(WaveModifier_ringModulation * self);

WaveModifier_ringModulation * WaveModifier_ringModulation_copy(WaveModifier_ringModulation * self);
bool WaveModifier_ringModulation_isEqual(WaveModifier_ringModulation * self, compat_type(WaveModifier_ringModulation *) compare);
uint32_t WaveModifier_ringModulation_hash(WaveModifier_ringModulation * self, uint32_t initval);
void WaveModifier_ringModulation_initCopy(WaveModifier_ringModulation * self, WaveModifier_ringModulation * original);
SamplerObject_state * WaveModifier_ringModulation_initState(WaveModifier_ringModulation * self);
void WaveModifier_ringModulation_disposeState(WaveModifier_ringModulation * self, SamplerObject_state * state);
unsigned int WaveModifier_ringModulation_getPropertyCount(WaveModifier_ringModulation * self);
SynthProperty WaveModifier_ringModulation_getPropertyAtIndex(WaveModifier_ringModulation * self, unsigned int index);
float WaveModifier_ringModulation_getPropertyValueStateless(WaveModifier_ringModulation * self, SynthPropertyIdentifier propertyIdentifier);
void WaveModifier_ringModulation_setPropertyValue(WaveModifier_ringModulation * self, SamplerObject_state * state, SynthPropertyIdentifier propertyIdentifier, float value);
float WaveModifier_ringModulation_sample(WaveModifier_ringModulation * self, SamplerObject_state * state, float phase, float phaseDelta, float time, float timeDelta);

#endif