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    EnabledBySetting=WebAudio,
28    Conditional=WEB_AUDIO,
29    ActiveDOMObject,
30    CustomConstructor,
31    EventTarget,
32    InterfaceName=webkitAudioContext
33] interface AudioContext {
34    // All rendered audio ultimately connects to destination, which represents the audio hardware.
35    readonly attribute AudioDestinationNode destination;
36
37    // All scheduled times are relative to this time in seconds.
38    readonly attribute float currentTime;
39
40    // All AudioNodes in the context run at this sample-rate (sample-frames per second).
41    readonly attribute float sampleRate;
42
43    // All panning is relative to this listener.
44    readonly attribute AudioListener listener;
45
46    // Number of AudioBufferSourceNodes that are currently playing.
47    readonly attribute unsigned long activeSourceCount;
48
49    [RaisesException] AudioBuffer createBuffer(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate);
50    [RaisesException] AudioBuffer createBuffer(ArrayBuffer? buffer, boolean mixToMono);
51
52    // Asynchronous audio file data decoding.
53    [RaisesException] void decodeAudioData(ArrayBuffer audioData, AudioBufferCallback successCallback, optional AudioBufferCallback errorCallback);
54
55    // Sources
56    AudioBufferSourceNode createBufferSource();
57
58#if defined(ENABLE_VIDEO) && ENABLE_VIDEO
59    [RaisesException] MediaElementAudioSourceNode createMediaElementSource(HTMLMediaElement mediaElement);
60#endif
61
62#if defined(ENABLE_MEDIA_STREAM) && ENABLE_MEDIA_STREAM
63    [RaisesException] MediaStreamAudioSourceNode createMediaStreamSource(MediaStream mediaStream);
64    MediaStreamAudioDestinationNode createMediaStreamDestination();
65#endif
66
67    // Processing nodes
68    GainNode createGain();
69    [RaisesException] DelayNode createDelay(optional double maxDelayTime);
70    BiquadFilterNode createBiquadFilter();
71    WaveShaperNode createWaveShaper();
72    PannerNode createPanner();
73    ConvolverNode createConvolver();
74    DynamicsCompressorNode createDynamicsCompressor();
75    AnalyserNode createAnalyser();
76    [RaisesException] ScriptProcessorNode createScriptProcessor(unsigned long bufferSize, optional unsigned long numberOfInputChannels, optional unsigned long numberOfOutputChannels);
77    OscillatorNode createOscillator();
78    [RaisesException] WaveTable createWaveTable(Float32Array real, Float32Array imag);
79
80    // Channel splitting and merging
81    [RaisesException] ChannelSplitterNode createChannelSplitter(optional unsigned long numberOfOutputs);
82    [RaisesException] ChannelMergerNode createChannelMerger(optional unsigned long numberOfInputs);
83
84    // Offline rendering
85    // void prepareOfflineBufferRendering(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate);
86    attribute EventListener oncomplete;
87    void startRendering();
88
89    [Conditional=LEGACY_WEB_AUDIO, ImplementedAs=createGain] GainNode createGainNode();
90    [Conditional=LEGACY_WEB_AUDIO, ImplementedAs=createDelay, RaisesException] DelayNode createDelayNode(optional double maxDelayTime);
91
92    [Conditional=LEGACY_WEB_AUDIO, ImplementedAs=createScriptProcessor, RaisesException] ScriptProcessorNode createJavaScriptNode(unsigned long bufferSize, optional unsigned long numberOfInputChannels, optional unsigned long numberOfOutputChannels);
93
94};
95