Home | History | Annotate | Download | only in webaudio 
      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     ActiveDOMObject,
     28     Conditional=WEB_AUDIO,
     29     Constructor,
     30     Constructor(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate),
     31     ConstructorCallWith=Document,
     32     NoInterfaceObject,
     33     RaisesException=Constructor,
     34 ] interface AudioContext : EventTarget {
     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 (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     // Number of AudioBufferSourceNodes that are currently playing.
     48     readonly attribute unsigned long activeSourceCount;
     49 
     50     [RaisesException] AudioBuffer createBuffer(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate);
     51     [RaisesException] AudioBuffer createBuffer(ArrayBuffer? buffer, boolean mixToMono);
     52 
     53     // Asynchronous audio file data decoding.
     54     [RaisesException] void decodeAudioData(ArrayBuffer audioData, AudioBufferCallback successCallback, optional AudioBufferCallback errorCallback);
     55 
     56     // Sources
     57     AudioBufferSourceNode createBufferSource();
     58 
     59     [RaisesException] MediaElementAudioSourceNode createMediaElementSource(HTMLMediaElement mediaElement);
     60 
     61     [RaisesException] MediaStreamAudioSourceNode createMediaStreamSource(MediaStream mediaStream);
     62     MediaStreamAudioDestinationNode createMediaStreamDestination();
     63 
     64     // Processing nodes
     65     GainNode createGain();
     66     [RaisesException] DelayNode createDelay(optional double maxDelayTime);
     67     BiquadFilterNode createBiquadFilter();
     68     WaveShaperNode createWaveShaper();
     69     PannerNode createPanner();
     70     ConvolverNode createConvolver();
     71     DynamicsCompressorNode createDynamicsCompressor();
     72     AnalyserNode createAnalyser();
     73     [RaisesException] ScriptProcessorNode createScriptProcessor(optional unsigned long bufferSize, optional unsigned long numberOfInputChannels, optional unsigned long numberOfOutputChannels);
     74     OscillatorNode createOscillator();
     75     [RaisesException] PeriodicWave createPeriodicWave(Float32Array real, Float32Array imag);
     76 
     77     // Channel splitting and merging
     78     [RaisesException] ChannelSplitterNode createChannelSplitter(optional unsigned long numberOfOutputs);
     79     [RaisesException] ChannelMergerNode createChannelMerger(optional unsigned long numberOfInputs);
     80 
     81     // Offline rendering
     82     // void prepareOfflineBufferRendering(unsigned long numberOfChannels, unsigned long numberOfFrames, float sampleRate);
     83     attribute EventHandler oncomplete;
     84     void startRendering();
     85 
     86     [MeasureAs=LegacyWebAudio, ImplementedAs=createGain] GainNode createGainNode();
     87     [MeasureAs=LegacyWebAudio, ImplementedAs=createDelay, RaisesException] DelayNode createDelayNode(optional double maxDelayTime);
     88 
     89     [MeasureAs=LegacyWebAudio, ImplementedAs=createScriptProcessor, RaisesException] ScriptProcessorNode createJavaScriptNode(unsigned long bufferSize, optional unsigned long numberOfInputChannels, optional unsigned long numberOfOutputChannels);
     90 
     91 };
     92