2012-08-31 13:59:37 -07:00
|
|
|
/* -*- 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/. */
|
|
|
|
|
2012-10-30 14:39:38 -07:00
|
|
|
#ifndef AudioContext_h_
|
|
|
|
#define AudioContext_h_
|
2012-09-18 16:07:33 -07:00
|
|
|
|
2013-10-28 17:08:14 -07:00
|
|
|
#include "mozilla/dom/AudioChannelBinding.h"
|
2013-02-01 14:13:23 -08:00
|
|
|
#include "MediaBufferDecoder.h"
|
2013-07-24 00:31:06 -07:00
|
|
|
#include "mozilla/Attributes.h"
|
2014-03-31 23:13:50 -07:00
|
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
|
|
#include "mozilla/MemoryReporting.h"
|
2013-07-24 00:31:06 -07:00
|
|
|
#include "mozilla/dom/TypedArray.h"
|
|
|
|
#include "nsAutoPtr.h"
|
|
|
|
#include "nsCOMPtr.h"
|
|
|
|
#include "nsCycleCollectionParticipant.h"
|
|
|
|
#include "nsHashKeys.h"
|
2013-04-24 20:32:41 -07:00
|
|
|
#include "nsTHashtable.h"
|
2013-08-27 19:59:14 -07:00
|
|
|
#include "js/TypeDecls.h"
|
2014-01-04 10:15:41 -08:00
|
|
|
#include "nsIMemoryReporter.h"
|
2012-08-31 13:59:37 -07:00
|
|
|
|
2013-03-14 18:01:02 -07:00
|
|
|
// X11 has a #define for CurrentTime. Unbelievable :-(.
|
2014-10-25 10:24:36 -07:00
|
|
|
// See dom/media/DOMMediaStream.h for more fun!
|
2013-03-14 18:01:02 -07:00
|
|
|
#ifdef CurrentTime
|
|
|
|
#undef CurrentTime
|
|
|
|
#endif
|
|
|
|
|
2013-04-12 08:28:33 -07:00
|
|
|
class nsPIDOMWindow;
|
2012-08-31 13:59:37 -07:00
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
|
2013-08-15 12:44:14 -07:00
|
|
|
class DOMMediaStream;
|
2012-08-31 13:59:37 -07:00
|
|
|
class ErrorResult;
|
2013-08-15 12:44:14 -07:00
|
|
|
class MediaStream;
|
|
|
|
class MediaStreamGraph;
|
2012-08-31 13:59:37 -07:00
|
|
|
|
2012-09-07 15:13:26 -07:00
|
|
|
namespace dom {
|
|
|
|
|
2013-03-31 20:41:14 -07:00
|
|
|
class AnalyserNode;
|
2012-09-21 15:42:14 -07:00
|
|
|
class AudioBuffer;
|
2012-11-05 16:26:03 -08:00
|
|
|
class AudioBufferSourceNode;
|
|
|
|
class AudioDestinationNode;
|
|
|
|
class AudioListener;
|
2013-09-16 16:53:40 -07:00
|
|
|
class AudioNode;
|
2012-11-07 17:59:14 -08:00
|
|
|
class BiquadFilterNode;
|
2013-05-05 08:49:37 -07:00
|
|
|
class ChannelMergerNode;
|
2013-05-05 08:49:13 -07:00
|
|
|
class ChannelSplitterNode;
|
2013-06-10 13:07:55 -07:00
|
|
|
class ConvolverNode;
|
2012-10-31 17:26:03 -07:00
|
|
|
class DelayNode;
|
2012-11-06 17:01:11 -08:00
|
|
|
class DynamicsCompressorNode;
|
2012-11-05 16:26:03 -08:00
|
|
|
class GainNode;
|
2013-07-24 20:01:49 -07:00
|
|
|
class HTMLMediaElement;
|
|
|
|
class MediaElementAudioSourceNode;
|
2013-08-22 22:17:08 -07:00
|
|
|
class GlobalObject;
|
2013-05-21 12:17:47 -07:00
|
|
|
class MediaStreamAudioDestinationNode;
|
2013-07-24 04:29:39 -07:00
|
|
|
class MediaStreamAudioSourceNode;
|
2013-08-19 11:53:00 -07:00
|
|
|
class OscillatorNode;
|
2012-11-05 18:14:13 -08:00
|
|
|
class PannerNode;
|
2013-04-13 18:37:04 -07:00
|
|
|
class ScriptProcessorNode;
|
2013-05-13 21:12:30 -07:00
|
|
|
class WaveShaperNode;
|
2013-06-19 15:24:26 -07:00
|
|
|
class PeriodicWave;
|
2014-10-23 03:07:48 -07:00
|
|
|
class Promise;
|
2012-09-18 16:07:33 -07:00
|
|
|
|
2014-03-31 23:13:50 -07:00
|
|
|
class AudioContext MOZ_FINAL : public DOMEventTargetHelper,
|
2014-02-06 05:36:46 -08:00
|
|
|
public nsIMemoryReporter
|
2012-08-31 13:59:37 -07:00
|
|
|
{
|
2013-05-16 16:30:42 -07:00
|
|
|
AudioContext(nsPIDOMWindow* aParentWindow,
|
|
|
|
bool aIsOffline,
|
2014-06-12 23:06:14 -07:00
|
|
|
AudioChannel aChannel,
|
2013-05-16 16:30:42 -07:00
|
|
|
uint32_t aNumberOfChannels = 0,
|
|
|
|
uint32_t aLength = 0,
|
|
|
|
float aSampleRate = 0.0f);
|
|
|
|
~AudioContext();
|
2012-08-31 13:59:37 -07:00
|
|
|
|
|
|
|
public:
|
2013-04-24 21:28:39 -07:00
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(AudioContext,
|
2014-03-31 23:13:50 -07:00
|
|
|
DOMEventTargetHelper)
|
2014-01-04 10:15:41 -08:00
|
|
|
MOZ_DEFINE_MALLOC_SIZE_OF(MallocSizeOf)
|
2012-08-31 13:59:37 -07:00
|
|
|
|
2013-04-12 08:28:33 -07:00
|
|
|
nsPIDOMWindow* GetParentObject() const
|
2012-08-31 13:59:37 -07:00
|
|
|
{
|
2013-04-24 21:28:39 -07:00
|
|
|
return GetOwner();
|
2012-08-31 13:59:37 -07:00
|
|
|
}
|
|
|
|
|
2013-09-09 22:05:22 -07:00
|
|
|
void Shutdown(); // idempotent
|
2013-03-21 19:59:33 -07:00
|
|
|
void Suspend();
|
|
|
|
void Resume();
|
|
|
|
|
2014-04-08 15:27:18 -07:00
|
|
|
virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
|
2012-08-31 13:59:37 -07:00
|
|
|
|
2014-03-31 23:13:50 -07:00
|
|
|
using DOMEventTargetHelper::DispatchTrustedEvent;
|
2013-05-16 16:30:57 -07:00
|
|
|
|
2013-05-16 16:30:41 -07:00
|
|
|
// Constructor for regular AudioContext
|
2012-08-31 13:59:37 -07:00
|
|
|
static already_AddRefed<AudioContext>
|
2012-12-03 08:07:49 -08:00
|
|
|
Constructor(const GlobalObject& aGlobal, ErrorResult& aRv);
|
2012-08-31 13:59:37 -07:00
|
|
|
|
2014-04-18 02:23:36 -07:00
|
|
|
// Constructor for regular AudioContext. A default audio channel is needed.
|
|
|
|
static already_AddRefed<AudioContext>
|
|
|
|
Constructor(const GlobalObject& aGlobal,
|
|
|
|
AudioChannel aChannel,
|
|
|
|
ErrorResult& aRv);
|
|
|
|
|
2013-05-16 16:30:41 -07:00
|
|
|
// Constructor for offline AudioContext
|
|
|
|
static already_AddRefed<AudioContext>
|
|
|
|
Constructor(const GlobalObject& aGlobal,
|
|
|
|
uint32_t aNumberOfChannels,
|
|
|
|
uint32_t aLength,
|
|
|
|
float aSampleRate,
|
|
|
|
ErrorResult& aRv);
|
|
|
|
|
|
|
|
// AudioContext methods
|
|
|
|
|
2012-09-18 16:07:33 -07:00
|
|
|
AudioDestinationNode* Destination() const
|
|
|
|
{
|
|
|
|
return mDestination;
|
|
|
|
}
|
|
|
|
|
2012-11-29 19:31:39 -08:00
|
|
|
float SampleRate() const
|
|
|
|
{
|
2013-05-24 10:09:29 -07:00
|
|
|
return mSampleRate;
|
2012-11-29 19:31:39 -08:00
|
|
|
}
|
|
|
|
|
2013-03-14 18:01:02 -07:00
|
|
|
double CurrentTime() const;
|
|
|
|
|
2012-11-05 16:26:03 -08:00
|
|
|
AudioListener* Listener();
|
|
|
|
|
2012-09-18 16:07:33 -07:00
|
|
|
already_AddRefed<AudioBufferSourceNode> CreateBufferSource();
|
|
|
|
|
2012-09-21 15:42:14 -07:00
|
|
|
already_AddRefed<AudioBuffer>
|
|
|
|
CreateBuffer(JSContext* aJSContext, uint32_t aNumberOfChannels,
|
|
|
|
uint32_t aLength, float aSampleRate,
|
|
|
|
ErrorResult& aRv);
|
|
|
|
|
2013-05-21 12:17:47 -07:00
|
|
|
already_AddRefed<MediaStreamAudioDestinationNode>
|
2013-07-18 02:57:38 -07:00
|
|
|
CreateMediaStreamDestination(ErrorResult& aRv);
|
2013-05-21 12:17:47 -07:00
|
|
|
|
2013-04-13 18:37:04 -07:00
|
|
|
already_AddRefed<ScriptProcessorNode>
|
|
|
|
CreateScriptProcessor(uint32_t aBufferSize,
|
|
|
|
uint32_t aNumberOfInputChannels,
|
|
|
|
uint32_t aNumberOfOutputChannels,
|
|
|
|
ErrorResult& aRv);
|
|
|
|
|
2013-03-31 20:41:14 -07:00
|
|
|
already_AddRefed<AnalyserNode>
|
|
|
|
CreateAnalyser();
|
|
|
|
|
2012-10-31 12:09:32 -07:00
|
|
|
already_AddRefed<GainNode>
|
|
|
|
CreateGain();
|
|
|
|
|
2013-05-13 21:12:30 -07:00
|
|
|
already_AddRefed<WaveShaperNode>
|
|
|
|
CreateWaveShaper();
|
|
|
|
|
2013-07-24 20:01:49 -07:00
|
|
|
already_AddRefed<MediaElementAudioSourceNode>
|
|
|
|
CreateMediaElementSource(HTMLMediaElement& aMediaElement, ErrorResult& aRv);
|
2013-07-24 04:29:39 -07:00
|
|
|
already_AddRefed<MediaStreamAudioSourceNode>
|
2013-07-24 19:07:34 -07:00
|
|
|
CreateMediaStreamSource(DOMMediaStream& aMediaStream, ErrorResult& aRv);
|
2013-07-24 04:29:39 -07:00
|
|
|
|
2012-10-31 17:26:03 -07:00
|
|
|
already_AddRefed<DelayNode>
|
2012-11-19 12:52:29 -08:00
|
|
|
CreateDelay(double aMaxDelayTime, ErrorResult& aRv);
|
2012-10-31 17:26:03 -07:00
|
|
|
|
2012-11-05 18:14:13 -08:00
|
|
|
already_AddRefed<PannerNode>
|
|
|
|
CreatePanner();
|
|
|
|
|
2013-06-10 13:07:55 -07:00
|
|
|
already_AddRefed<ConvolverNode>
|
|
|
|
CreateConvolver();
|
|
|
|
|
2013-05-05 08:49:13 -07:00
|
|
|
already_AddRefed<ChannelSplitterNode>
|
|
|
|
CreateChannelSplitter(uint32_t aNumberOfOutputs, ErrorResult& aRv);
|
|
|
|
|
2013-05-05 08:49:37 -07:00
|
|
|
already_AddRefed<ChannelMergerNode>
|
|
|
|
CreateChannelMerger(uint32_t aNumberOfInputs, ErrorResult& aRv);
|
|
|
|
|
2012-11-06 17:01:11 -08:00
|
|
|
already_AddRefed<DynamicsCompressorNode>
|
|
|
|
CreateDynamicsCompressor();
|
|
|
|
|
2012-11-07 17:59:14 -08:00
|
|
|
already_AddRefed<BiquadFilterNode>
|
|
|
|
CreateBiquadFilter();
|
|
|
|
|
2013-08-19 11:53:00 -07:00
|
|
|
already_AddRefed<OscillatorNode>
|
|
|
|
CreateOscillator();
|
|
|
|
|
2013-06-19 15:24:26 -07:00
|
|
|
already_AddRefed<PeriodicWave>
|
|
|
|
CreatePeriodicWave(const Float32Array& aRealData, const Float32Array& aImagData,
|
|
|
|
ErrorResult& aRv);
|
2013-05-28 04:19:07 -07:00
|
|
|
|
2014-10-23 03:07:48 -07:00
|
|
|
already_AddRefed<Promise>
|
|
|
|
DecodeAudioData(const ArrayBuffer& aBuffer,
|
|
|
|
const Optional<OwningNonNull<DecodeSuccessCallback> >& aSuccessCallback,
|
|
|
|
const Optional<OwningNonNull<DecodeErrorCallback> >& aFailureCallback);
|
2013-02-01 14:13:23 -08:00
|
|
|
|
2013-05-16 16:30:41 -07:00
|
|
|
// OfflineAudioContext methods
|
2013-09-15 22:14:45 -07:00
|
|
|
void StartRendering(ErrorResult& aRv);
|
2013-05-16 16:30:41 -07:00
|
|
|
IMPL_EVENT_HANDLER(complete)
|
|
|
|
|
2013-05-16 16:31:08 -07:00
|
|
|
bool IsOffline() const { return mIsOffline; }
|
2013-02-04 15:07:25 -08:00
|
|
|
|
|
|
|
MediaStreamGraph* Graph() const;
|
|
|
|
MediaStream* DestinationStream() const;
|
2013-09-16 16:53:40 -07:00
|
|
|
|
|
|
|
// Nodes register here if they will produce sound even if they have silent
|
|
|
|
// or no input connections. The AudioContext will keep registered nodes
|
|
|
|
// alive until the context is collected. This takes care of "playing"
|
|
|
|
// references and "tail-time" references.
|
|
|
|
void RegisterActiveNode(AudioNode* aNode);
|
|
|
|
// Nodes unregister when they have finished producing sound for the
|
|
|
|
// foreseeable future.
|
|
|
|
// Do NOT call UnregisterActiveNode from an AudioNode destructor.
|
|
|
|
// If the destructor is called, then the Node has already been unregistered.
|
|
|
|
// The destructor may be called during hashtable enumeration, during which
|
|
|
|
// unregistering would not be safe.
|
|
|
|
void UnregisterActiveNode(AudioNode* aNode);
|
|
|
|
|
2013-04-11 05:47:57 -07:00
|
|
|
void UnregisterAudioBufferSourceNode(AudioBufferSourceNode* aNode);
|
|
|
|
void UnregisterPannerNode(PannerNode* aNode);
|
|
|
|
void UpdatePannerSource();
|
2013-02-04 15:07:25 -08:00
|
|
|
|
2013-06-10 10:32:28 -07:00
|
|
|
uint32_t MaxChannelCount() const;
|
|
|
|
|
2013-07-03 17:44:32 -07:00
|
|
|
void Mute() const;
|
|
|
|
void Unmute() const;
|
|
|
|
|
2014-05-09 11:33:17 -07:00
|
|
|
JSObject* GetGlobalJSObject() const;
|
|
|
|
|
2013-10-11 04:55:47 -07:00
|
|
|
AudioChannel MozAudioChannelType() const;
|
2014-11-12 08:52:30 -08:00
|
|
|
void SetMozAudioChannelType(AudioChannel aValue, ErrorResult& aRv);
|
2013-10-11 04:55:47 -07:00
|
|
|
|
2014-08-03 06:46:17 -07:00
|
|
|
AudioChannel TestAudioChannelInAudioNodeStream();
|
|
|
|
|
2014-01-15 03:08:20 -08:00
|
|
|
void UpdateNodeCount(int32_t aDelta);
|
|
|
|
|
|
|
|
double DOMTimeToStreamTime(double aTime) const
|
|
|
|
{
|
|
|
|
return aTime - ExtraCurrentTime();
|
|
|
|
}
|
|
|
|
|
2014-08-12 16:05:09 -07:00
|
|
|
double StreamTimeToDOMTime(double aTime) const
|
|
|
|
{
|
|
|
|
return aTime + ExtraCurrentTime();
|
|
|
|
}
|
|
|
|
|
2014-06-12 23:06:14 -07:00
|
|
|
IMPL_EVENT_HANDLER(mozinterruptbegin)
|
|
|
|
IMPL_EVENT_HANDLER(mozinterruptend)
|
|
|
|
|
2013-02-01 14:13:23 -08:00
|
|
|
private:
|
2014-01-15 03:08:20 -08:00
|
|
|
/**
|
|
|
|
* Returns the amount of extra time added to the current time of the
|
|
|
|
* AudioDestinationNode's MediaStream to get this AudioContext's currentTime.
|
|
|
|
* Must be subtracted from all DOM API parameter times that are on the same
|
|
|
|
* timeline as AudioContext's currentTime to get times we can pass to the
|
|
|
|
* MediaStreamGraph.
|
|
|
|
*/
|
|
|
|
double ExtraCurrentTime() const;
|
|
|
|
|
2013-02-01 14:13:23 -08:00
|
|
|
void RemoveFromDecodeQueue(WebAudioDecodeJob* aDecodeJob);
|
2013-08-02 09:07:17 -07:00
|
|
|
void ShutdownDecoder();
|
2013-02-01 14:13:23 -08:00
|
|
|
|
2014-01-04 10:15:41 -08:00
|
|
|
size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
|
|
|
|
NS_IMETHOD CollectReports(nsIHandleReportCallback* aHandleReport,
|
2014-05-20 23:06:54 -07:00
|
|
|
nsISupports* aData, bool aAnonymize);
|
2014-01-04 10:15:41 -08:00
|
|
|
|
2013-02-01 14:13:23 -08:00
|
|
|
friend struct ::mozilla::WebAudioDecodeJob;
|
|
|
|
|
2012-08-31 13:59:37 -07:00
|
|
|
private:
|
2013-05-24 10:09:29 -07:00
|
|
|
// Note that it's important for mSampleRate to be initialized before
|
|
|
|
// mDestination, as mDestination's constructor needs to access it!
|
|
|
|
const float mSampleRate;
|
2012-09-18 16:07:33 -07:00
|
|
|
nsRefPtr<AudioDestinationNode> mDestination;
|
2012-11-05 16:26:03 -08:00
|
|
|
nsRefPtr<AudioListener> mListener;
|
2013-02-01 14:13:23 -08:00
|
|
|
MediaBufferDecoder mDecoder;
|
2013-07-16 02:00:36 -07:00
|
|
|
nsTArray<nsRefPtr<WebAudioDecodeJob> > mDecodeJobs;
|
2013-09-16 16:53:40 -07:00
|
|
|
// See RegisterActiveNode. These will keep the AudioContext alive while it
|
|
|
|
// is rendering and the window remains alive.
|
|
|
|
nsTHashtable<nsRefPtrHashKey<AudioNode> > mActiveNodes;
|
2013-09-23 18:47:00 -07:00
|
|
|
// Hashsets containing all the PannerNodes, to compute the doppler shift.
|
|
|
|
// These are weak pointers.
|
2013-04-24 20:32:41 -07:00
|
|
|
nsTHashtable<nsPtrHashKey<PannerNode> > mPannerNodes;
|
2013-06-10 10:32:28 -07:00
|
|
|
// Number of channels passed in the OfflineAudioContext ctor.
|
|
|
|
uint32_t mNumberOfChannels;
|
2014-01-15 03:08:20 -08:00
|
|
|
// Number of nodes that currently exist for this AudioContext
|
|
|
|
int32_t mNodeCount;
|
2013-05-16 16:30:41 -07:00
|
|
|
bool mIsOffline;
|
2013-09-15 22:14:45 -07:00
|
|
|
bool mIsStarted;
|
2013-09-17 18:10:30 -07:00
|
|
|
bool mIsShutDown;
|
2012-08-31 13:59:37 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
}
|
2012-09-07 15:13:26 -07:00
|
|
|
}
|
2012-08-31 13:59:37 -07:00
|
|
|
|
2012-10-30 14:39:38 -07:00
|
|
|
#endif
|
|
|
|
|