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
26module webaudio {
27    interface [
28        Conditional=WEB_AUDIO,
29        ActiveDOMObject,
30        CanBeConstructed,
31        CustomConstructFunction,
32        V8CustomConstructor,
33        CustomMarkFunction,
34#if defined(V8_BINDING) && V8_BINDING
35        EventTarget
36#endif
37    ] AudioContext {
38        // All rendered audio ultimately connects to destination, which represents the audio hardware.
39        readonly attribute AudioDestinationNode destination;
40
41        // All scheduled times are relative to this time in seconds.
42        readonly attribute float currentTime;
43
44        // All AudioNodes in the context run at this sample-rate (in sample-frames per second).
45        readonly attribute float sampleRate;
46
47        // All panning is relative to this listener.
48        readonly attribute AudioListener listener;
49
50        // AudioBuffer createBuffer(in unsigned long numberOfChannels, in unsigned long numberOfFrames, in float sampleRate);
51        // AudioBuffer createBuffer(in ArrayBuffer buffer, in boolean mixToMono);
52        [Custom] AudioBuffer createBuffer()
53            raises(DOMException);
54
55        // Source
56        AudioBufferSourceNode createBufferSource();
57
58        // Processing nodes
59        AudioGainNode createGainNode();
60        DelayNode createDelayNode();
61        LowPass2FilterNode createLowPass2Filter();
62        HighPass2FilterNode createHighPass2Filter();
63        AudioPannerNode createPanner();
64        ConvolverNode createConvolver();
65        RealtimeAnalyserNode createAnalyser();
66        JavaScriptAudioNode createJavaScriptNode(in unsigned long bufferSize);
67
68        // Channel splitting and merging
69        AudioChannelSplitter createChannelSplitter();
70        AudioChannelMerger createChannelMerger();
71
72        // Offline rendering
73        // void prepareOfflineBufferRendering(in unsigned long numberOfChannels, in unsigned long numberOfFrames, in float sampleRate);
74        attribute EventListener oncomplete;
75        void startRendering();
76
77    };
78}
79