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
30namespace WebCore { class AudioBus; }
31
32#if WEBKIT_IMPLEMENTATION
33namespace WTF { template <typename T> class PassOwnPtr; }
34#endif
35
36namespace WebKit {
37
38class 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//
44class WebAudioBus {
45public:
46    WebAudioBus() : m_private(0) { }
47    ~WebAudioBus() { reset(); }
48
49    // initialize() allocates memory of the given length for the given number of channels.
50    WEBKIT_API void initialize(unsigned numberOfChannels, size_t length, double sampleRate);
51
52    // reset() releases the memory allocated from initialize().
53    WEBKIT_API void reset();
54
55    WEBKIT_API unsigned numberOfChannels() const;
56    WEBKIT_API size_t length() const;
57    WEBKIT_API double sampleRate() const;
58
59    WEBKIT_API float* channelData(unsigned channelIndex);
60
61#if WEBKIT_IMPLEMENTATION
62    WTF::PassOwnPtr<WebCore::AudioBus> release();
63#endif
64
65private:
66    // Disallow copy and assign.
67    WebAudioBus(const WebAudioBus&);
68    void operator=(const WebAudioBus&);
69
70    WebCore::AudioBus* m_private;
71};
72
73} // namespace WebKit
74
75#endif // WebAudioBus_h
76