src/third_party/WebKit/Source/modules/webaudio/AudioBuffer.h

   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  *
   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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef AudioBuffer_h
  30 #define AudioBuffer_h
  31
  32 #include "bindings/core/v8/ScriptWrappable.h"
  33 #include "core/dom/DOMTypedArray.h"
  34 #include "wtf/Float32Array.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefPtr.h"
  37 #include "wtf/Vector.h"
  38
  39 namespace blink {
  40
  41 class AudioBus;
  42 class ExceptionState;
  43
  44 class AudioBuffer : public GarbageCollectedFinalized<AudioBuffer>, public ScriptWrappable {
  45     DEFINE_WRAPPERTYPEINFO();
  46 public:
  47     static AudioBuffer* create(unsigned numberOfChannels, size_t numberOfFrames, float sampleRate);
  48     static AudioBuffer* create(unsigned numberOfChannels, size_t numberOfFrames, float sampleRate, ExceptionState&);
  49
  50     // Returns 0 if data is not a valid audio file.
  51     static AudioBuffer* createFromAudioFileData(const void* data, size_t dataSize, bool mixToMono, float sampleRate);
  52
  53     static AudioBuffer* createFromAudioBus(AudioBus*);
  54
  55     // Format
  56     size_t length() const { return m_length; }
  57     double duration() const { return length() / static_cast<double>(sampleRate()); }
  58     float sampleRate() const { return m_sampleRate; }
  59
  60     // Channel data access
  61     unsigned numberOfChannels() const { return m_channels.size(); }
  62     PassRefPtr<DOMFloat32Array> getChannelData(unsigned channelIndex, ExceptionState&);
  63     Float32Array* getChannelData(unsigned channelIndex);
  64     void zero();
  65
  66     void trace(Visitor*) { }
  67
  68     virtual v8::Handle<v8::Object> associateWithWrapper(const WrapperTypeInfo*, v8::Handle<v8::Object> wrapper, v8::Isolate*) override;
  69
  70 protected:
  71     AudioBuffer(unsigned numberOfChannels, size_t numberOfFrames, float sampleRate);
  72     explicit AudioBuffer(AudioBus*);
  73     bool createdSuccessfully(unsigned desiredNumberOfChannels) const;
  74
  75     float m_sampleRate;
  76     size_t m_length;
  77
  78     Vector<RefPtr<Float32Array> > m_channels;
  79 };
  80
  81 } // namespace blink
  82
  83 #endif // AudioBuffer_h