AEDSPGenerateOscillator - maybe document that it's just a loose approximation of a sine wave

TheAmazingAudioEngine / TheAmazingAudioEngine2

The Amazing Audio Engine is a sophisticated framework for iOS audio applications, built so you don't have to.

http://theamazingaudioengine.com/doc2

Other

544 stars 87 forks source link

AEDSPGenerateOscillator - maybe document that it's just a loose approximation of a sine wave #23

Closed jackpal closed 8 years ago

jackpal commented 8 years ago

Currently AEDSPGenerateOscillator's docs say

This function produces, sample by sample, a sine-line oscillator signal.

But the current formula is y = (x * 2 - 1) * 2 over the range -1..1, which is not a very accurate approximation of a real sine wave. People using this to debug their code might think that something was wrong with their audio processing pipeline.

I'd suggest either using an accurate approximation or documenting the the function produces a loose approximation of a sine wave.

michaeltyson commented 8 years ago

Bugger. That was meant to be "sine-like" rather than "sine-line" =)