ee2214cec3381d3190615445a2ae731e62a973e6
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AsyncAudioDecoder.h
1 /*
2  * Copyright (C) 2011, 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 AsyncAudioDecoder_h
26 #define AsyncAudioDecoder_h
27
28 #include <memory>
29 #include <wtf/Forward.h>
30 #include <wtf/MessageQueue.h>
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/Threading.h>
34
35 namespace JSC {
36 class ArrayBuffer;
37 }
38
39 namespace WebCore {
40
41 class AudioBuffer;
42 class AudioBufferCallback;
43
44 // AsyncAudioDecoder asynchronously decodes audio file data from an ArrayBuffer in a worker thread.
45 // Upon successful decoding, a completion callback will be invoked with the decoded PCM data in an AudioBuffer.
46
47 class AsyncAudioDecoder {
48     WTF_MAKE_NONCOPYABLE(AsyncAudioDecoder);
49 public:
50     AsyncAudioDecoder();
51     ~AsyncAudioDecoder();
52
53     // Must be called on the main thread.
54     void decodeAsync(JSC::ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback);
55
56 private:
57     class DecodingTask {
58         WTF_MAKE_NONCOPYABLE(DecodingTask);
59     public:
60         DecodingTask(JSC::ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback);
61         void decode();
62         
63     private:
64         JSC::ArrayBuffer* audioData() { return m_audioData.get(); }
65         float sampleRate() const { return m_sampleRate; }
66         AudioBufferCallback* successCallback() { return m_successCallback.get(); }
67         AudioBufferCallback* errorCallback() { return m_errorCallback.get(); }
68         AudioBuffer* audioBuffer() { return m_audioBuffer.get(); }
69
70         static void notifyCompleteDispatch(void* userData);
71         void notifyComplete();
72
73         RefPtr<JSC::ArrayBuffer> m_audioData;
74         float m_sampleRate;
75         RefPtr<AudioBufferCallback> m_successCallback;
76         RefPtr<AudioBufferCallback> m_errorCallback;
77         RefPtr<AudioBuffer> m_audioBuffer;
78     };
79     
80     static void threadEntry(void* threadData);
81     void runLoop();
82
83     WTF::ThreadIdentifier m_threadID;
84     DeprecatedMutex m_threadCreationMutex;
85     MessageQueue<DecodingTask> m_queue;
86 };
87
88 } // namespace WebCore
89
90 #endif // AsyncAudioDecoder_h