1/*
2 * Copyright (C) 2010, Google Inc. All rights reserved.
3 * Copyright (C) 2011 Apple Inc. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1.  Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26[
27    NoInterfaceObject,
28    Conditional=WEB_AUDIO,
29    ActiveDOMObject,
30    CustomConstructor
31] interface AudioContext : EventTarget {
32    // All rendered audio ultimately connects to destination, which represents the audio hardware.
33    readonly attribute AudioDestinationNode destination;
34
35    // All scheduled times are relative to this time in seconds.
36    readonly attribute float currentTime;
37
38    // All AudioNodes in the context run at this sample-rate (sample-frames per second).
39    readonly attribute float sampleRate;
40
41    // All panning is relative to this listener.
42    readonly attribute AudioListener listener;
43
44    // Number of AudioBufferSourceNodes that are currently playing.
45    readonly attribute unsigned long activeSourceCount;
46
47    [RaisesException] AudioBuffer createBuffer(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate);
48    [RaisesException] AudioBuffer createBuffer(ArrayBuffer? buffer, boolean mixToMono);
49
50    // Asynchronous audio file data decoding.
51    [RaisesException] void decodeAudioData(ArrayBuffer audioData, AudioBufferCallback successCallback, optional AudioBufferCallback errorCallback);
52
53    // Sources
54    AudioBufferSourceNode createBufferSource();
55
56    [RaisesException] MediaElementAudioSourceNode createMediaElementSource(HTMLMediaElement mediaElement);
57
58    [RaisesException] MediaStreamAudioSourceNode createMediaStreamSource(MediaStream mediaStream);
59    MediaStreamAudioDestinationNode createMediaStreamDestination();
60
61    // Processing nodes
62    GainNode createGain();
63    [RaisesException] DelayNode createDelay(optional double maxDelayTime);
64    BiquadFilterNode createBiquadFilter();
65    WaveShaperNode createWaveShaper();
66    PannerNode createPanner();
67    ConvolverNode createConvolver();
68    DynamicsCompressorNode createDynamicsCompressor();
69    AnalyserNode createAnalyser();
70    [RaisesException] ScriptProcessorNode createScriptProcessor(unsigned long bufferSize, optional unsigned long numberOfInputChannels, optional unsigned long numberOfOutputChannels);
71    OscillatorNode createOscillator();
72    [RaisesException] PeriodicWave createPeriodicWave(Float32Array real, Float32Array imag);
73
74    // Channel splitting and merging
75    [RaisesException] ChannelSplitterNode createChannelSplitter(optional unsigned long numberOfOutputs);
76    [RaisesException] ChannelMergerNode createChannelMerger(optional unsigned long numberOfInputs);
77
78    // Offline rendering
79    // void prepareOfflineBufferRendering(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate);
80    attribute EventHandler oncomplete;
81    void startRendering();
82
83    [MeasureAs=LegacyWebAudio, ImplementedAs=createGain] GainNode createGainNode();
84    [MeasureAs=LegacyWebAudio, ImplementedAs=createDelay, RaisesException] DelayNode createDelayNode(optional double maxDelayTime);
85
86    [MeasureAs=LegacyWebAudio, ImplementedAs=createScriptProcessor, RaisesException] ScriptProcessorNode createJavaScriptNode(unsigned long bufferSize, optional unsigned long numberOfInputChannels, optional unsigned long numberOfOutputChannels);
87
88};
89