WebCore/webaudio/RealtimeAnalyserNode.idl

   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 audio {
  26     interface [
  27         Conditional=WEB_AUDIO,
  28         GenerateToJS
  29     ] RealtimeAnalyserNode : AudioNode {
  30         attribute unsigned long fftSize;
  31         readonly attribute unsigned long frequencyBinCount;
  32
  33         // minDecibels / maxDecibels represent the range to scale the FFT analysis data for conversion to unsigned byte values.
  34         attribute float minDecibels;
  35         attribute float maxDecibels;
  36
  37         // A value from 0.0 -> 1.0 where 0.0 represents no time averaging with the last analysis frame.
  38         attribute float smoothingTimeConstant;
  39
  40         // Copies the current frequency data into the passed array.
  41         // If the array has fewer elements than the frequencyBinCount, the excess elements will be dropped.
  42         [Conditional=3D_CANVAS] void getFloatFrequencyData(in Float32Array array);
  43         [Conditional=3D_CANVAS] void getByteFrequencyData(in Uint8Array array);
  44
  45         // Real-time waveform data
  46         [Conditional=3D_CANVAS] void getByteTimeDomainData(in Uint8Array array);
  47     };
  48 }