Home | History | Annotate | Download | only in webaudio
      1 /*
      2  * Copyright (C) 2010, Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  * 1.  Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  * 2.  Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
     20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     23  */
     24 
     25 module webaudio {
     26     interface [
     27         Conditional=WEB_AUDIO,
     28         CanBeConstructed,
     29         CustomConstructFunction,
     30         V8CustomConstructor,
     31 #if defined(V8_BINDING) && V8_BINDING
     32         EventTarget
     33 #endif
     34     ] AudioContext {
     35         // All rendered audio ultimately connects to destination, which represents the audio hardware.
     36         readonly attribute AudioDestinationNode destination;
     37 
     38         // All scheduled times are relative to this time in seconds.
     39         readonly attribute float currentTime;
     40 
     41         // All AudioNodes in the context run at this sample-rate (in sample-frames per second).
     42         readonly attribute float sampleRate;
     43 
     44         // All panning is relative to this listener.
     45         readonly attribute AudioListener listener;
     46 
     47         // AudioBuffer createBuffer(in unsigned long numberOfChannels, in unsigned long numberOfFrames, in float sampleRate);
     48         // AudioBuffer createBuffer(in ArrayBuffer buffer, in boolean mixToMono);
     49         [Custom] AudioBuffer createBuffer()
     50             raises(DOMException);
     51 
     52         // Source
     53         AudioBufferSourceNode createBufferSource();
     54 
     55         // Processing nodes
     56         AudioGainNode createGainNode();
     57         DelayNode createDelayNode();
     58         LowPass2FilterNode createLowPass2Filter();
     59         HighPass2FilterNode createHighPass2Filter();
     60         AudioPannerNode createPanner();
     61         ConvolverNode createConvolver();
     62         RealtimeAnalyserNode createAnalyser();
     63         JavaScriptAudioNode createJavaScriptNode(in unsigned long bufferSize);
     64 
     65         // Channel splitting and merging
     66         AudioChannelSplitter createChannelSplitter();
     67         AudioChannelMerger createChannelMerger();
     68 
     69         // Offline rendering
     70         // void prepareOfflineBufferRendering(in unsigned long numberOfChannels, in unsigned long numberOfFrames, in float sampleRate);
     71         attribute EventListener oncomplete;
     72         void startRendering();
     73 
     74     };
     75 }
     76