src/third_party/WebKit/public/platform/WebAudioBus.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  * 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 #ifndef WebAudioBus_h
  26 #define WebAudioBus_h
  27
  28 #include "WebCommon.h"
  29
  30 namespace WebCore { class AudioBus; }
  31
  32 #if INSIDE_BLINK
  33 namespace WTF { template <typename T> class PassRefPtr; }
  34 #endif
  35
  36 namespace WebKit {
  37
  38 class WebAudioBusPrivate;
  39
  40 // A container for multi-channel linear PCM audio data.
  41 //
  42 // WARNING: It is not safe to pass a WebAudioBus across threads!!!
  43 //
  44 class BLINK_PLATFORM_EXPORT WebAudioBus {
  45 public:
  46     WebAudioBus() : m_private(0) { }
  47     ~WebAudioBus() { reset(); }
  48
  49     // initialize() allocates memory of the given length for the given number of channels.
  50     void initialize(unsigned numberOfChannels, size_t length, double sampleRate);
  51
  52     // resizeSmaller() can only be called after initialize() with a new length <= the initialization length.
  53     // The data stored in the bus will remain undisturbed.
  54     void resizeSmaller(size_t newLength);
  55
  56     // reset() releases the memory allocated from initialize().
  57     void reset();
  58
  59     unsigned numberOfChannels() const;
  60     size_t length() const;
  61     double sampleRate() const;
  62
  63     float* channelData(unsigned channelIndex);
  64
  65 #if INSIDE_BLINK
  66     WTF::PassRefPtr<WebCore::AudioBus> release();
  67 #endif
  68
  69 private:
  70     // Disallow copy and assign.
  71     WebAudioBus(const WebAudioBus&);
  72     void operator=(const WebAudioBus&);
  73
  74     WebCore::AudioBus* m_private;
  75 };
  76
  77 } // namespace WebKit
  78
  79 #endif // WebAudioBus_h