mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-07 04:05:49 +00:00
575 lines
16 KiB
C++
575 lines
16 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim:set ts=2 sw=2 sts=2 et cindent: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "OscillatorNode.h"
|
|
#include "AudioNodeEngine.h"
|
|
#include "AudioNodeStream.h"
|
|
#include "AudioDestinationNode.h"
|
|
#include "WebAudioUtils.h"
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_CLASS(OscillatorNode)
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(OscillatorNode)
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK(mPeriodicWave)
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK(mFrequency)
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK(mDetune)
|
|
if (tmp->Context()) {
|
|
tmp->Context()->UnregisterOscillatorNode(tmp);
|
|
}
|
|
NS_IMPL_CYCLE_COLLECTION_UNLINK_END_INHERITED(AudioNode);
|
|
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(OscillatorNode, AudioNode)
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mPeriodicWave)
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mFrequency)
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mDetune)
|
|
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
|
|
|
|
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(OscillatorNode)
|
|
NS_INTERFACE_MAP_END_INHERITING(AudioNode)
|
|
|
|
NS_IMPL_ADDREF_INHERITED(OscillatorNode, AudioNode)
|
|
NS_IMPL_RELEASE_INHERITED(OscillatorNode, AudioNode)
|
|
|
|
static const float sLeak = 0.995f;
|
|
|
|
class DCBlocker
|
|
{
|
|
public:
|
|
// These are sane defauts when the initial mPhase is zero
|
|
DCBlocker(float aLastInput = 0.0f,
|
|
float aLastOutput = 0.0f,
|
|
float aPole = 0.995)
|
|
:mLastInput(aLastInput),
|
|
mLastOutput(aLastOutput),
|
|
mPole(aPole)
|
|
{
|
|
MOZ_ASSERT(aPole > 0);
|
|
}
|
|
|
|
inline float Process(float aInput)
|
|
{
|
|
float out;
|
|
|
|
out = mLastOutput * mPole + aInput - mLastInput;
|
|
mLastOutput = out;
|
|
mLastInput = aInput;
|
|
|
|
return out;
|
|
}
|
|
private:
|
|
float mLastInput;
|
|
float mLastOutput;
|
|
float mPole;
|
|
};
|
|
|
|
|
|
class OscillatorNodeEngine : public AudioNodeEngine
|
|
{
|
|
public:
|
|
OscillatorNodeEngine(AudioNode* aNode, AudioDestinationNode* aDestination)
|
|
: AudioNodeEngine(aNode)
|
|
, mSource(nullptr)
|
|
, mDestination(static_cast<AudioNodeStream*> (aDestination->Stream()))
|
|
, mStart(-1)
|
|
, mStop(TRACK_TICKS_MAX)
|
|
// Keep the default values in sync with OscillatorNode::OscillatorNode.
|
|
, mFrequency(440.f)
|
|
, mDetune(0.f)
|
|
, mType(OscillatorType::Sine)
|
|
, mPhase(0.)
|
|
, mFinalFrequency(0.0)
|
|
, mNumberOfHarmonics(0)
|
|
, mSignalPeriod(0.0)
|
|
, mAmplitudeAtZero(0.0)
|
|
, mPhaseIncrement(0.0)
|
|
, mSquare(0.0)
|
|
, mTriangle(0.0)
|
|
, mSaw(0.0)
|
|
, mPhaseWrap(0.0)
|
|
, mRecomputeFrequency(true)
|
|
{
|
|
}
|
|
|
|
void SetSourceStream(AudioNodeStream* aSource)
|
|
{
|
|
mSource = aSource;
|
|
}
|
|
|
|
enum Parameters {
|
|
FREQUENCY,
|
|
DETUNE,
|
|
TYPE,
|
|
PERIODICWAVE,
|
|
START,
|
|
STOP,
|
|
};
|
|
void SetTimelineParameter(uint32_t aIndex,
|
|
const AudioParamTimeline& aValue,
|
|
TrackRate aSampleRate) MOZ_OVERRIDE
|
|
{
|
|
mRecomputeFrequency = true;
|
|
switch (aIndex) {
|
|
case FREQUENCY:
|
|
MOZ_ASSERT(mSource && mDestination);
|
|
mFrequency = aValue;
|
|
WebAudioUtils::ConvertAudioParamToTicks(mFrequency, mSource, mDestination);
|
|
break;
|
|
case DETUNE:
|
|
MOZ_ASSERT(mSource && mDestination);
|
|
mDetune = aValue;
|
|
WebAudioUtils::ConvertAudioParamToTicks(mDetune, mSource, mDestination);
|
|
break;
|
|
default:
|
|
NS_ERROR("Bad OscillatorNodeEngine TimelineParameter");
|
|
}
|
|
}
|
|
|
|
virtual void SetStreamTimeParameter(uint32_t aIndex, TrackTicks aParam)
|
|
{
|
|
switch (aIndex) {
|
|
case START: mStart = aParam; break;
|
|
case STOP: mStop = aParam; break;
|
|
default:
|
|
NS_ERROR("Bad OscillatorNodeEngine StreamTimeParameter");
|
|
}
|
|
}
|
|
|
|
virtual void SetInt32Parameter(uint32_t aIndex, int32_t aParam)
|
|
{
|
|
mType = static_cast<OscillatorType>(aParam);
|
|
// Set the new type, and update integrators with the new initial conditions.
|
|
switch (mType) {
|
|
case OscillatorType::Sine:
|
|
mPhase = 0.0;
|
|
break;
|
|
case OscillatorType::Square:
|
|
mPhase = 0.0;
|
|
// Initial integration condition is -0.5, because our square has 50%
|
|
// duty cycle.
|
|
mSquare = -0.5;
|
|
break;
|
|
case OscillatorType::Triangle:
|
|
// Initial mPhase and related integration condition so the triangle is
|
|
// in the middle of the first upward slope.
|
|
// XXX actually do the maths and put the right number here.
|
|
mPhase = (float)(M_PI / 2);
|
|
mSquare = 0.5;
|
|
mTriangle = 0.0;
|
|
break;
|
|
case OscillatorType::Sawtooth:
|
|
/* initial mPhase so the oscillator start at the middle
|
|
* of the ramp, per spec */
|
|
mPhase = (float)(M_PI / 2);
|
|
/* mSaw = 0 when mPhase = pi/2 */
|
|
mSaw = 0.0;
|
|
break;
|
|
default:
|
|
NS_ERROR("Bad OscillatorNodeEngine Int32Parameter.");
|
|
};
|
|
}
|
|
|
|
void IncrementPhase()
|
|
{
|
|
mPhase += mPhaseIncrement;
|
|
if (mPhase > mPhaseWrap) {
|
|
mPhase -= mPhaseWrap;
|
|
}
|
|
}
|
|
|
|
// Square and triangle are using a bipolar band-limited impulse train, saw is
|
|
// using a normal band-limited impulse train.
|
|
bool UsesBipolarBLIT() {
|
|
return mType == OscillatorType::Square || mType == OscillatorType::Triangle;
|
|
}
|
|
|
|
void UpdateFrequencyIfNeeded(TrackTicks ticks, size_t count)
|
|
{
|
|
double frequency, detune;
|
|
|
|
bool simpleFrequency = mFrequency.HasSimpleValue();
|
|
bool simpleDetune = mDetune.HasSimpleValue();
|
|
|
|
// Shortcut if frequency-related AudioParam are not automated, and we
|
|
// already have computed the frequency information and related parameters.
|
|
if (simpleFrequency && simpleDetune && !mRecomputeFrequency) {
|
|
return;
|
|
}
|
|
|
|
if (simpleFrequency) {
|
|
frequency = mFrequency.GetValue();
|
|
} else {
|
|
frequency = mFrequency.GetValueAtTime(ticks, count);
|
|
}
|
|
if (simpleDetune) {
|
|
detune = mDetune.GetValue();
|
|
} else {
|
|
detune = mDetune.GetValueAtTime(ticks, count);
|
|
}
|
|
|
|
mFinalFrequency = frequency * pow(2., detune / 1200.);
|
|
mRecomputeFrequency = false;
|
|
|
|
// When using bipolar BLIT, we divide the signal period by two, because we
|
|
// are using two BLIT out of phase.
|
|
mSignalPeriod = UsesBipolarBLIT() ? 0.5 * mSource->SampleRate() / mFinalFrequency
|
|
: mSource->SampleRate() / mFinalFrequency;
|
|
// Wrap the phase accordingly:
|
|
mPhaseWrap = UsesBipolarBLIT() || mType == OscillatorType::Sine ? 2 * M_PI
|
|
: M_PI;
|
|
// Even number of harmonics for bipolar blit, odd otherwise.
|
|
mNumberOfHarmonics = UsesBipolarBLIT() ? 2 * floor(0.5 * mSignalPeriod)
|
|
: 2 * floor(0.5 * mSignalPeriod) + 1;
|
|
mPhaseIncrement = mType == OscillatorType::Sine ? 2 * M_PI / mSignalPeriod
|
|
: M_PI / mSignalPeriod;
|
|
mAmplitudeAtZero = mNumberOfHarmonics / mSignalPeriod;
|
|
}
|
|
|
|
void FillBounds(float* output, TrackTicks ticks,
|
|
uint32_t& start, uint32_t& end)
|
|
{
|
|
MOZ_ASSERT(output);
|
|
static_assert(TrackTicks(WEBAUDIO_BLOCK_SIZE) < UINT_MAX,
|
|
"WEBAUDIO_BLOCK_SIZE overflows interator bounds.");
|
|
start = 0;
|
|
if (ticks < mStart) {
|
|
start = mStart - ticks;
|
|
for (uint32_t i = 0; i < start; ++i) {
|
|
output[i] = 0.0;
|
|
}
|
|
}
|
|
end = WEBAUDIO_BLOCK_SIZE;
|
|
if (ticks + end > mStop) {
|
|
end = mStop - ticks;
|
|
for (uint32_t i = end; i < WEBAUDIO_BLOCK_SIZE; ++i) {
|
|
output[i] = 0.0;
|
|
}
|
|
}
|
|
}
|
|
|
|
float BipolarBLIT()
|
|
{
|
|
float blit;
|
|
float denom = sin(mPhase);
|
|
|
|
if (fabs(denom) < std::numeric_limits<float>::epsilon()) {
|
|
if (mPhase < 0.1f || mPhase > 2 * M_PI - 0.1f) {
|
|
blit = mAmplitudeAtZero;
|
|
} else {
|
|
blit = -mAmplitudeAtZero;
|
|
}
|
|
} else {
|
|
blit = sin(mNumberOfHarmonics * mPhase);
|
|
blit /= mSignalPeriod * denom;
|
|
}
|
|
return blit;
|
|
}
|
|
|
|
float UnipolarBLIT()
|
|
{
|
|
float blit;
|
|
float denom = sin(mPhase);
|
|
|
|
if (fabs(denom) <= std::numeric_limits<float>::epsilon()) {
|
|
blit = mAmplitudeAtZero;
|
|
} else {
|
|
blit = sin(mNumberOfHarmonics * mPhase);
|
|
blit /= mSignalPeriod * denom;
|
|
}
|
|
|
|
return blit;
|
|
}
|
|
|
|
void ComputeSine(float * aOutput, TrackTicks ticks, uint32_t aStart, uint32_t aEnd)
|
|
{
|
|
for (uint32_t i = aStart; i < aEnd; ++i) {
|
|
UpdateFrequencyIfNeeded(ticks, i);
|
|
|
|
aOutput[i] = sin(mPhase);
|
|
|
|
IncrementPhase();
|
|
}
|
|
}
|
|
|
|
void ComputeSquare(float * aOutput, TrackTicks ticks, uint32_t aStart, uint32_t aEnd)
|
|
{
|
|
for (uint32_t i = aStart; i < aEnd; ++i) {
|
|
UpdateFrequencyIfNeeded(ticks, i);
|
|
// Integration to get us a square. It turns out we can have a
|
|
// pure integrator here.
|
|
mSquare += BipolarBLIT();
|
|
aOutput[i] = mSquare;
|
|
// maybe we want to apply a gain, the wg has not decided yet
|
|
aOutput[i] *= 1.5;
|
|
IncrementPhase();
|
|
}
|
|
}
|
|
|
|
void ComputeSawtooth(float * aOutput, TrackTicks ticks, uint32_t aStart, uint32_t aEnd)
|
|
{
|
|
float dcoffset;
|
|
for (uint32_t i = aStart; i < aEnd; ++i) {
|
|
UpdateFrequencyIfNeeded(ticks, i);
|
|
// DC offset so the Saw does not ramp up to infinity when integrating.
|
|
dcoffset = mFinalFrequency / mSource->SampleRate();
|
|
// Integrate and offset so we get mAmplitudeAtZero sawtooth. We have a
|
|
// very low frequency component somewhere here, but I'm not sure where.
|
|
mSaw += UnipolarBLIT() - dcoffset;
|
|
// reverse the saw so we are spec compliant
|
|
aOutput[i] = -mSaw * 1.5;
|
|
|
|
IncrementPhase();
|
|
}
|
|
}
|
|
|
|
void ComputeTriangle(float * aOutput, TrackTicks ticks, uint32_t aStart, uint32_t aEnd)
|
|
{
|
|
for (uint32_t i = aStart; i < aEnd; ++i) {
|
|
UpdateFrequencyIfNeeded(ticks, i);
|
|
// Integrate to get a square
|
|
mSquare += BipolarBLIT();
|
|
// Leaky integrate to get a triangle. We get too much dc offset if we don't
|
|
// leaky integrate here.
|
|
// C6 = k0 / period
|
|
// (period is samplingrate / frequency, k0 = (PI/2)/(2*PI)) = 0.25
|
|
float C6 = 0.25 / (mSource->SampleRate() / mFinalFrequency);
|
|
mTriangle = mTriangle * sLeak + mSquare + C6;
|
|
// DC Block, and scale back to [-1.0; 1.0]
|
|
aOutput[i] = mDCBlocker.Process(mTriangle) / (mSignalPeriod/2) * 1.5;
|
|
|
|
IncrementPhase();
|
|
}
|
|
}
|
|
|
|
void ComputeSilence(AudioChunk *aOutput)
|
|
{
|
|
aOutput->SetNull(WEBAUDIO_BLOCK_SIZE);
|
|
}
|
|
|
|
virtual void ProduceAudioBlock(AudioNodeStream* aStream,
|
|
const AudioChunk& aInput,
|
|
AudioChunk* aOutput,
|
|
bool* aFinished) MOZ_OVERRIDE
|
|
{
|
|
MOZ_ASSERT(mSource == aStream, "Invalid source stream");
|
|
|
|
TrackTicks ticks = aStream->GetCurrentPosition();
|
|
if (mStart == -1) {
|
|
ComputeSilence(aOutput);
|
|
return;
|
|
}
|
|
|
|
if (ticks + WEBAUDIO_BLOCK_SIZE < mStart) {
|
|
// We're not playing yet.
|
|
ComputeSilence(aOutput);
|
|
return;
|
|
}
|
|
if (ticks >= mStop) {
|
|
// We've finished playing.
|
|
ComputeSilence(aOutput);
|
|
*aFinished = true;
|
|
return;
|
|
}
|
|
|
|
AllocateAudioBlock(1, aOutput);
|
|
float* output = static_cast<float*>(
|
|
const_cast<void*>(aOutput->mChannelData[0]));
|
|
|
|
uint32_t start, end;
|
|
FillBounds(output, ticks, start, end);
|
|
|
|
// Synthesize the correct waveform.
|
|
switch(mType) {
|
|
case OscillatorType::Sine:
|
|
ComputeSine(output, ticks, start, end);
|
|
break;
|
|
case OscillatorType::Square:
|
|
ComputeSquare(output, ticks, start, end);
|
|
break;
|
|
case OscillatorType::Triangle:
|
|
ComputeTriangle(output, ticks, start, end);
|
|
break;
|
|
case OscillatorType::Sawtooth:
|
|
ComputeSawtooth(output, ticks, start, end);
|
|
break;
|
|
default:
|
|
ComputeSilence(aOutput);
|
|
};
|
|
|
|
}
|
|
|
|
DCBlocker mDCBlocker;
|
|
AudioNodeStream* mSource;
|
|
AudioNodeStream* mDestination;
|
|
TrackTicks mStart;
|
|
TrackTicks mStop;
|
|
AudioParamTimeline mFrequency;
|
|
AudioParamTimeline mDetune;
|
|
OscillatorType mType;
|
|
float mPhase;
|
|
float mFinalFrequency;
|
|
uint32_t mNumberOfHarmonics;
|
|
float mSignalPeriod;
|
|
float mAmplitudeAtZero;
|
|
float mPhaseIncrement;
|
|
float mSquare;
|
|
float mTriangle;
|
|
float mSaw;
|
|
float mPhaseWrap;
|
|
bool mRecomputeFrequency;
|
|
};
|
|
|
|
OscillatorNode::OscillatorNode(AudioContext* aContext)
|
|
: AudioNode(aContext,
|
|
2,
|
|
ChannelCountMode::Max,
|
|
ChannelInterpretation::Speakers)
|
|
, mType(OscillatorType::Sine)
|
|
, mFrequency(new AudioParam(MOZ_THIS_IN_INITIALIZER_LIST(),
|
|
SendFrequencyToStream, 440.0f))
|
|
, mDetune(new AudioParam(MOZ_THIS_IN_INITIALIZER_LIST(),
|
|
SendDetuneToStream, 0.0f))
|
|
, mStartCalled(false)
|
|
, mStopped(false)
|
|
{
|
|
OscillatorNodeEngine* engine = new OscillatorNodeEngine(this, aContext->Destination());
|
|
mStream = aContext->Graph()->CreateAudioNodeStream(engine, MediaStreamGraph::SOURCE_STREAM);
|
|
engine->SetSourceStream(static_cast<AudioNodeStream*> (mStream.get()));
|
|
}
|
|
|
|
OscillatorNode::~OscillatorNode()
|
|
{
|
|
if (Context()) {
|
|
Context()->UnregisterOscillatorNode(this);
|
|
}
|
|
}
|
|
|
|
JSObject*
|
|
OscillatorNode::WrapObject(JSContext* aCx, JS::Handle<JSObject*> aScope)
|
|
{
|
|
return OscillatorNodeBinding::Wrap(aCx, aScope, this);
|
|
}
|
|
|
|
void
|
|
OscillatorNode::SendFrequencyToStream(AudioNode* aNode)
|
|
{
|
|
OscillatorNode* This = static_cast<OscillatorNode*>(aNode);
|
|
SendTimelineParameterToStream(This, OscillatorNodeEngine::FREQUENCY, *This->mFrequency);
|
|
}
|
|
|
|
void
|
|
OscillatorNode::SendDetuneToStream(AudioNode* aNode)
|
|
{
|
|
OscillatorNode* This = static_cast<OscillatorNode*>(aNode);
|
|
SendTimelineParameterToStream(This, OscillatorNodeEngine::DETUNE, *This->mDetune);
|
|
}
|
|
|
|
void
|
|
OscillatorNode::SendTypeToStream()
|
|
{
|
|
SendInt32ParameterToStream(OscillatorNodeEngine::TYPE, static_cast<int32_t>(mType));
|
|
if (mType == OscillatorType::Custom) {
|
|
// TODO: Send the custom wave table somehow
|
|
}
|
|
}
|
|
|
|
void
|
|
OscillatorNode::Start(double aWhen, ErrorResult& aRv)
|
|
{
|
|
if (!WebAudioUtils::IsTimeValid(aWhen)) {
|
|
aRv.Throw(NS_ERROR_DOM_NOT_SUPPORTED_ERR);
|
|
return;
|
|
}
|
|
|
|
if (mStartCalled) {
|
|
aRv.Throw(NS_ERROR_DOM_INVALID_STATE_ERR);
|
|
return;
|
|
}
|
|
mStartCalled = true;
|
|
|
|
AudioNodeStream* ns = static_cast<AudioNodeStream*>(mStream.get());
|
|
if (!ns) {
|
|
// Nothing to play, or we're already dead for some reason
|
|
return;
|
|
}
|
|
|
|
// TODO: Perhaps we need to do more here.
|
|
ns->SetStreamTimeParameter(OscillatorNodeEngine::START,
|
|
Context()->DestinationStream(),
|
|
aWhen);
|
|
|
|
MOZ_ASSERT(!mPlayingRef, "We can only accept a successful start() call once");
|
|
mPlayingRef.Take(this);
|
|
}
|
|
|
|
void
|
|
OscillatorNode::Stop(double aWhen, ErrorResult& aRv)
|
|
{
|
|
if (!WebAudioUtils::IsTimeValid(aWhen)) {
|
|
aRv.Throw(NS_ERROR_DOM_NOT_SUPPORTED_ERR);
|
|
return;
|
|
}
|
|
|
|
if (!mStartCalled) {
|
|
aRv.Throw(NS_ERROR_DOM_INVALID_STATE_ERR);
|
|
return;
|
|
}
|
|
|
|
mPlayingRef.Drop(this);
|
|
|
|
AudioNodeStream* ns = static_cast<AudioNodeStream*>(mStream.get());
|
|
if (!ns || !Context()) {
|
|
// We've already stopped and had our stream shut down
|
|
return;
|
|
}
|
|
|
|
// TODO: Perhaps we need to do more here.
|
|
ns->SetStreamTimeParameter(OscillatorNodeEngine::STOP,
|
|
Context()->DestinationStream(),
|
|
std::max(0.0, aWhen));
|
|
}
|
|
|
|
void
|
|
OscillatorNode::NotifyMainThreadStateChanged()
|
|
{
|
|
if (mStream->IsFinished()) {
|
|
class EndedEventDispatcher : public nsRunnable
|
|
{
|
|
public:
|
|
explicit EndedEventDispatcher(OscillatorNode* aNode)
|
|
: mNode(aNode) {}
|
|
NS_IMETHODIMP Run()
|
|
{
|
|
// If it's not safe to run scripts right now, schedule this to run later
|
|
if (!nsContentUtils::IsSafeToRunScript()) {
|
|
nsContentUtils::AddScriptRunner(this);
|
|
return NS_OK;
|
|
}
|
|
|
|
mNode->DispatchTrustedEvent(NS_LITERAL_STRING("ended"));
|
|
return NS_OK;
|
|
}
|
|
private:
|
|
nsRefPtr<OscillatorNode> mNode;
|
|
};
|
|
if (!mStopped) {
|
|
// Only dispatch the ended event once
|
|
NS_DispatchToMainThread(new EndedEventDispatcher(this));
|
|
mStopped = true;
|
|
}
|
|
|
|
// Drop the playing reference
|
|
// Warning: The below line might delete this.
|
|
mPlayingRef.Drop(this);
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
|